aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2020-03-01 11:17:29 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2020-03-01 11:24:09 +0300
commit0352e233955bc5d04344a4ae3ef04436d8299ae1 (patch)
tree7b99b9bbf7b6390cbea22966ba257dfd09f1fea9 /README.md
parentTravis: lint the config (diff)
downloadcgitize-0352e233955bc5d04344a4ae3ef04436d8299ae1.tar.gz
cgitize-0352e233955bc5d04344a4ae3ef04436d8299ae1.zip
rename the modules
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.md b/README.md
index fcd207c..0db6aad 100644
--- a/README.md
+++ b/README.md
@@ -11,13 +11,13 @@ Usage
Adjust the config in [examples/cgit-repos.conf] and pass it using the
`--config` parameter:
- > python3 -m pull.main --config path/to/cgit-repos.conf
+ > python3 -m cgit.repos.main --config path/to/cgit-repos.conf
The repository list is stored in my_repos.py (the `my_repos` setting in the
config).
See [examples/my_repos.py] for an example.
-pull/main.py calls git, which might call ssh internally.
+cgit/repos/main.py calls git, which might call ssh internally.
Make sure the required keys are loaded to a ssh-agent.
[examples/cgit-repos.conf]: examples/cgit-repos.conf
@@ -37,7 +37,7 @@ For example:
-v "/path/to/config:/etc/cgit-repos:ro" \
-v "$SSH_AUTH_SOCK:/var/run/cgit-repos/ssh-agent.sock" \
-v "/path/to/output:/var/tmp/cgit-repos/output" \
- egortensin/pull-cgit-repos
+ egortensin/cgit-repos
### my_repos.py
@@ -63,7 +63,7 @@ To build an image:
Requires [Pylint].
- > pylint pull
+ > pylint cgit
[Pylint]: https://www.pylint.org/