0216eacef6
- removed old comments - moved todos and nice-to-haves into the README.md's todos and hopes - changed gobally mutated variables to be global constants. originally these were mutated because the code was structured differently, and allowed an option argument, specifying which bare git repo to use, but i removed that, and forgot to remove and change the cruft
60 lines
1 KiB
Markdown
60 lines
1 KiB
Markdown
# repo2html
|
|
|
|
a post-receive hook that generates an html view of a git repository.
|
|
|
|
## features
|
|
|
|
TODO
|
|
|
|
## caveats
|
|
|
|
TODO
|
|
|
|
## disclaimer
|
|
|
|
TODO
|
|
|
|
## requirements
|
|
|
|
- [chicken scheme](https://call-cc.org/)
|
|
- [utf8 egg](https://wiki.call-cc.org/eggref/5/utf8)
|
|
- [lowdown egg](https://wiki.call-cc.org/eggref/5/lowdown)
|
|
|
|
**note**: if you have chicken scheme installed, then you can install the eggs
|
|
above by running `sudo make dependencies`.
|
|
|
|
## quickstart
|
|
|
|
TODO
|
|
|
|
## compilation
|
|
|
|
sudo make dependencies
|
|
make
|
|
sudo make install
|
|
|
|
## server setup
|
|
|
|
TODO (git user, ssh, ufw ports, web directory, git-daemon, mkdir /home/git/projects, post-receive hook, systemd service)
|
|
|
|
## usage
|
|
|
|
TODO
|
|
|
|
## configuration
|
|
|
|
TODO
|
|
|
|
## todos
|
|
|
|
- ☐ nav link: License (look for LICENSE file)
|
|
- ☐ nav link: Contributors
|
|
|
|
## hopes
|
|
|
|
- ☐ clickable line numbers in source files
|
|
- ☐ render images
|
|
- ☐ make repos with more files and directories less daunting (recursively generate a files list page for each directory in a repo?)
|
|
- ☐ nav link: Releases
|
|
|
|
TODO
|