Skip to content

Commit 4399e7d

Browse files
author
Jean-Louis Fuchs
committed
add more python version on the CI and explain the use-cases of git-darcs
1 parent 80818dc commit 4399e7d

File tree

2 files changed

+41
-1
lines changed

2 files changed

+41
-1
lines changed

.github/workflows/test.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@ jobs:
1515
name: integration test ${{ matrix.python-version }}
1616
runs-on: ubuntu-22.04
1717
strategy:
18+
fail-fast: false
1819
matrix:
19-
python-version: ["3.8", "3.9", "3.10"]
20+
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
2021
steps:
2122
- name: Checkout
2223
uses: actions/checkout@v2

README.md

+39
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ Incremental import of git into darcs and back again
66
[git-darcs on pypi](https://pypi.org/project/git-darcs/)
77

88
- [Warning](#-warning)
9+
- [Install](#Install)
10+
- [Use-cases](#use-cases)
11+
* [Main use-case](#main-use-case)
12+
* [Other use-case](#other-use-case)
913
- [Tutorial](#Tutorial)
1014
- [But why?](#but-why)
1115
- [For darcs beginners](#for-darcs-beginners)
@@ -30,9 +34,44 @@ almost no error-reporting, you'll have to read the traceback.
3034

3135
![demo](https://github.com/ganwell/git-darcs/blob/main/demo.gif?raw=true)
3236

37+
Install
38+
=======
39+
40+
Integration tests run on python 3.7 - 3.11.
41+
42+
```bash
43+
pip install git-darcs
44+
```
45+
46+
Use-cases
47+
=========
48+
49+
Main use-case
50+
-------------
51+
52+
Use the excellent capabilities of darcs to craft consistent, clear and concise
53+
patches while the remote repository still remains git. Thats the situation most
54+
of us in are because at work we have to use git.
55+
56+
Other use-cases
57+
---------------
58+
59+
* Convert a git repository to darcs using the [linearized history](#linearized-history)
60+
proposed by git-darcs
61+
* Visualize a git-repository using `darcs show dependencies`
62+
3363
Tutorial
3464
========
3565

66+
The tutorial covers the main use-case:
67+
68+
1. Check-out a git-repo, because at work you have to use git
69+
2. Snapshot the latest commit into darcs
70+
3. Craft patches: Use the excellent capabilities of darcs to move code between
71+
patches to create very consistent and clean patches
72+
4. Use `git darcs pull` to bring the darcs-patches back into git and
73+
create pull-request
74+
3675
Clone your tracking-repository.
3776

3877
```bash

0 commit comments

Comments
 (0)