fixes #38: add docs for vcs setting

mxstack · Feb 28, 2024 · cd47fd9 · cd47fd9
1 parent fd15157
commit cd47fd9
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -9,6 +9,9 @@
   This change enables the use of the generated file with the alternative pip replacement `uv`.
   [jensens]
 
+- Document sections `vcs` setting.
+  [jensens]
+
 ### 3.1.0 (2023-12-10)
 
 - Feature: Provide `directory` default setting [rnix]

diff --git a/README.md b/README.md
@@ -191,6 +191,22 @@ Optional a writable URL for pushes can be specified.
 If the `pushurl` is set after initial checkout it is not applied.
 To apply it remove the repository and checkout again.
 
+#### `vcs = VCS`
+
+The version control system to use.
+
+Supported are:
+- `git` (stable, tested)
+- `fs` (stable, tested) - in fact no vcs, but points to a local directory.
+  This can be achieved without mxdev by using `-e PATH` in the requirements input file.
+- `svn` (unstable, test needs rewrite)
+- `gitsvn` (unstable, test needs rewrite)
+- `hg` (unstable, test needs rewrite)
+- `bzr` (unstable, test needs rewrite)
+- `darcs` (unstable, test needs rewrite)
+
+Defaults to `git`.
+
 #### `branch = BRANCHNAME_OR_TAG`
 
 The branch name or tag to checkout.