diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..fe3d758 --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +rejoinder +========= + +**rejoinder** is a dead-simple comments system. Adding comments to a page is +as simple as adding a single link. rejoinder does not require user registration +and provides for basic moderation. + + +build +---- + +``` +git clone https://sanine.net/git/rejoinder +mkdir rejoinder/build +cd rejoinder/build +cmake .. +make +``` + + +usage +----- + +rejoinder requires two files to function: a configuration file, specified +by the environment variable `REJOINDER_CONFIG` or the fallback `/etc/rejoinder.rc`, +and a database file, whose location is specified either globally or +on a site-specific basis by the configuration file. + + +dependencies +------------ + +* libsqlite3 +* cmake +* that's it + + +thanks +------ + +rejoinder relies on [iniparser] by Nicolas Devillard. +This project would not have been created without the very helpful [CGI scripting pages] by Marshall Brian. +I also took significant structural inspiration from [cgit] by Jason Donenfeld. +And last but most certainly not least, the support of the lovely people at [Layer Zero] was +extremely helpful in writing this code. + +Thank you all! + +[iniparser]: https://github.com/ndevilla/iniparser +[CGI scripting pages]: https://computer.howstuffworks.com/cgi.htm +[Layer Zero]: https://layerze.ro +[cgit]: https://git.zx2c4.com/cgit/about/ |