repo2html/README.md

# 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
first commit 2022-12-02 21:41:55 +00:00			`# repo2html`

changed description 2022-12-02 22:13:34 +00:00			`a post-receive hook that generates an html view of a git repository.`
first commit 2022-12-02 21:41:55 +00:00
			`## features`

			`TODO`

			`## caveats`

			`TODO`

			`## disclaimer`

			`TODO`

			`## requirements`

docs: updated requirements 2022-12-02 21:54:38 +00:00			`- [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`.
first commit 2022-12-02 21:41:55 +00:00
			`## quickstart`

			`TODO`

			`## compilation`

fixed codeblock in readme 2022-12-02 21:49:37 +00:00			`sudo make dependencies`
			`make`
			`sudo make install`
first commit 2022-12-02 21:41:55 +00:00
combined two sections into one 2022-12-02 22:34:21 +00:00			`## server setup`
first commit 2022-12-02 21:41:55 +00:00
			`TODO (git user, ssh, ufw ports, web directory, git-daemon, mkdir /home/git/projects, post-receive hook, systemd service)`

			`## usage`

			`TODO`

			`## configuration`

			`TODO`

			`## todos`

cleaned up main.scm - 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 2022-12-03 04:31:54 +00:00			`- ☐ nav link: License (look for LICENSE file)`
			`- ☐ nav link: Contributors`
first commit 2022-12-02 21:41:55 +00:00
			`## hopes`

cleaned up main.scm - 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 2022-12-03 04:31:54 +00:00			`- ☐ 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`

first commit 2022-12-02 21:41:55 +00:00			`TODO`