README
1 ┌─────┐ 2 │~sgw~│ 3 └─────┘ 4 5 Static Git Webpage (Generator). 6 7 Build: 8 Run "make" to create the gitsta binary. Then, run "make install" as root 9 to install, if that's what you want. 10 11 Documentation/Usage: 12 Calling gitsta with the --help option will print a usage guide. For 13 further info, you can read the man page via "mandoc gitsta.1" or simply 14 "man gitsta" (if you installed it). 15 16 Dependencies: 17 - C compiler (C99) 18 - libc (tested with OpenBSD, FreeBSD, NetBSD, Linux: glibc and musl) 19 - libgit2 (v0.22+) 20 - POSIX make (optional) 21 22 Tool Features: 23 - Allows specifying output directory 24 - Can generate repository pages, index page, or both. 25 - Minimal options at runtime 26 27 Webpage Features: 28 - customizable via config.h: 29 - header/footer 30 - webpage structure: link destinations, page locations, etc. 31 - nested directory pages (or not), whether to show backlinks 32 - Presents log of all commits from HEAD 33 - Presents file tree at HEAD 34 - Text files have linkable line numbers 35 - Binary files have preview (via object tag) and download link. 36 - Links README, LICENSE, and submodules in headers. 37 - Atom feeds for the commit log (atom.xml) and tags/refs (tags.xml). 38 - Compatible with text-browsers such as dillo, links, lynx and w3m. 39 40 TODO: 41 See TODO.