Commit e3e73aa
Changed files (1)
README.md
@@ -1,59 +1,36 @@
# 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.
+Static site generator for Git repositories.
## Usage
-```bash
-gitmal [options] [path]
+```
+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
-
-## URL Structure
-
-Generated paths follow GitHub repository conventions:
-
| Path | Description |
|------|-------------|
-| `/index.html` | Repository root (file listing) |
+| `/index.html` | Repository root |
| `/blob/<ref>/<path>/index.html` | Directory listing |
-| `/blob/<ref>/<file>.html` | File view (syntax highlighted) |
-| `/commit/<hash>.html` | Commit diff view |
-| `/commits/<ref>/index.html` | Commit history (page 1) |
-| `/commits/<ref>/page-N.html` | Commit history (page N) |
-| `/branches.html` | Branches list |
-| `/tags.html` | Tags list |
-| `/compare/<base>...<head>/` | Diff between refs |
-
-### Feeds & API
-
-| Path | Description |
-|------|-------------|
-| `/commits/<ref>.atom` | Commits Atom feed |
+| `/blob/<ref>/<file>.html` | File view |
+| `/commit/<hash>.html` | Commit diff |
+| `/commits/<ref>/index.html` | Commit history |
+| `/branches.html` | Branches |
+| `/tags.html` | Tags |
+| `/commits/<ref>.atom` | Commits feed |
| `/commits/<ref>.json` | Commits JSON |
-| `/tags.atom` | Tags Atom feed |
-| `/releases.atom` | Releases Atom feed |
| `/branches.json` | Branches JSON |
+## CSS
+
+Generated pages load CSS from `https://src.mokhan.ca/assets/`.
+
## License
MIT