commit 76e18b5c89af75861a0df379d794de34a1d2f219
parent 9840adaca3a24b9bce781b7b1ed03243b8b1f2ed
Author: krasjet <nil@krj.st>
Date: Sun, 12 Jul 2020 19:35:37 -0700
readme: more details about file structure
Diffstat:
1 file changed, 19 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
@@ -11,11 +11,26 @@ Installation
Before installing `grm`, make sure you have set up your git server following
the instructions in [section 4.4][3] of Pro Git. Optionally, you should also
have [git daemon][1] ready for the public access of repositories, which is
-documented in [section 4.5][4] of Pro Git. If you want to have a web interface
-for your repository, you should also have [stagit][2] compiled and installed on
-your server.
+documented in [section 4.5][4] of Pro Git. The basic structure of your git
+repositories root should have the following structure:
-Edit `grm` script to fill in some configurations,
+```
+$GRM_REPOS_ROOT
+├── private-repo.git
+│ ├── branches
+│ ├── HEAD
+│ └── ...
+└── public-repo.git
+ ├── branches
+ ├── HEAD
+ ├── ...
+ └── git-daemon-export-ok
+```
+
+If you want to have a web interface for your repositories, you should also have
+[stagit][2] compiled and installed on your server.
+
+To use git repo manager, edit the `grm` script to fill in some configurations,
```bash
# root directory of git repositories
