~kornellapacz/gmnigit

8070917b7e55893ecf4be648a55459e5a7a92ecc — Korneliusz Łapacz 2 months ago f5c1f8b
update README.md, mention -refs flag
1 files changed, 10 insertions(+), 2 deletions(-)

M README.md
M README.md => README.md +10 -2
@@ 1,6 1,6 @@
# gmnigit

Static git gemini viewer written in golang. Inspired by [stagit](https://codemadness.org/git/stagit/log.html). Project is in early development, help is appreciated!
Static git gemini viewer written in golang. Inspired by [stagit](https://codemadness.org/git/stagit/log.html).

This repository is available at [sourcehut](https://git.sr.ht/~kornellapacz/gmnigit) and [gemini](gemini://lapacz-kornel.dev/git/gmnigit/).



@@ 13,7 13,6 @@ git clone https://git.sr.ht/~kornellapacz/gmnigit
cd gmnigit
go build -o gmnigit
```

place `gmnigit` binary somewhere in your `$PATH`.

## Usage


@@ 22,14 21,23 @@ place `gmnigit` binary somewhere in your `$PATH`.
Usage of gmnigit:
  -dist string
        destination path (if exists will be overwritten)
  -name string
    	project name, mandatory if generating the tags page
  -perms
        show files permissions in browsable tree (default false)
  -refs
    	generate the tags page
  -repo string
        path to repository
  -url string
       clone URL for end user (optional)
```

Example
```
gmnigit -repo path/do/repo -dist dist/path
```

## Tips

You can automate building pages on push with git `post-receive` hook