diff options
| author | dan <[email protected]> | 2023-05-15 12:53:39 -0400 |
|---|---|---|
| committer | dan <[email protected]> | 2023-05-15 12:53:39 -0400 |
| commit | bee64e69fd73729123989348c8008caf8443ad98 (patch) | |
| tree | d719a812a29753916dad308718414844ec2683e9 /readme.md | |
| parent | 9691f2c2d7cff4136bbd96dd5591160efa140956 (diff) | |
| download | simple-comments-widget-bee64e69fd73729123989348c8008caf8443ad98.tar.gz simple-comments-widget-bee64e69fd73729123989348c8008caf8443ad98.tar.bz2 simple-comments-widget-bee64e69fd73729123989348c8008caf8443ad98.zip | |
docs: add readme
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..45837ad --- /dev/null +++ b/readme.md @@ -0,0 +1,22 @@ +## simple-comments-widget + +Two parts, a server `main.scm`, written in Chicken Scheme, and a frontend written in html+js+css. + +### Running the application + +To start the server, run `make run`. +To start the client, open `client.html` in a web browser. + +The server, `main.scm` requires the following 'eggs' (i.e. Chicken Scheme packages): `spiffy intarweb uri-common sqlite3 medea srfi-1`. + +The server relies on sqlite3, this needs to be present on the system and linked by the compiler. e.g. `chicken-csc -static ./main.scm -L -lsqlite3` + +The frontend doesn't need any compilation, or even hosting, it should work if you just open it in any modern web browser. + +The provided html file is intended as an example usage. In practice, one would probably want to embed the comments form & thread inside another page (and most likely restyle them!). + +### License + +Released into the public domain. + +Monday 15th May 2023 |