Cybrkyd's git repositories

GitGen • commit: c24312f

commit c24312f527592d5be3547531d905e5acf59c114d174018ba66c7387dbd46d61c
author cybrkyd <noreply@cybrkyd.com> 2026-01-15 20:57:42 +0000
committer cybrkyd <noreply@cybrkyd.com> 2026-01-15 20:57:42 +0000

Commit Message

Usage verbage on README

📊 Diffstat

README.md 20
1 files changed, 20 insertions(+), 0 deletions(-)

Diff

diff --git a/README.md b/README.md
index d4a0d42..40c82f5 100644
--- a/README.md
+++ b/README.md
@@ -39,6 +39,26 @@ Install with:
pip install markdown
```
+ ## Usage
+
+ 1. Place the script somewhere on your system.
+ 2. Edit the default base path to repositories:
+
+ ```
+ GitRepoScanner:
+ def __init__(self, base_path: str = "/home/cybr/Work/cybrkyd-git")
+ ```
+
+ 3. Run the script:
+
+ ```bash
+ python3 gitgen.py
+ ```
+
+ 4. The generated site will be written to the `git-website/` directory by default.
+
+ Open `git-website/index.html` in a browser or deploy the directory to a static web host.
+
## Licence
This project is made available under a GPL3 licence -- see COPYING for the full text.