Commit 076a5bc

mo khan <mo@mokhan.ca>
2026-01-31 03:06:58
docs: add README
1 parent c196720
Changed files (1)
README.md
@@ -0,0 +1,39 @@
+# gitmal
+
+A static site generator for Git repositories. Generates browsable HTML pages similar to GitHub's repository interface, with code browsing, commit history, branches, and tags.
+
+## Usage
+
+```bash
+gitmal [options] [path]
+```
+
+### Options
+
+- `--output` - Output directory (default: `output`)
+
+### Example
+
+```bash
+gitmal --output=./site /path/to/repo
+```
+
+## Output
+
+Generates a static site with:
+
+- **Code browser** - Syntax-highlighted source files with line numbers
+- **Markdown rendering** - README files rendered with GitHub-flavored markdown
+- **Commit history** - Paginated commit logs with diff views
+- **Branches & Tags** - Navigation between refs
+- **Atom feeds** - For commits, tags, and releases
+
+## Building
+
+```bash
+go build ./cmd/gitmal
+```
+
+## License
+
+MIT