make a docs directory, add a very short manual.

master
Ted Unangst 5 years ago
parent 106edfb77d
commit 6bd837c378

@ -51,4 +51,6 @@ Then run honk.
./honk
Refer also to the docs directory, in particular manual.txt.
Busy honk instances may use megabytes of memory.

@ -0,0 +1,17 @@
Instructions for running of the honk.
-- css
Custom CSS may be provided by creating a views/local.css file.
-- message
A custom server message may be set adding a ('servermsg', 'message') entry to
the config table using sqlite3.
-- emus
Custom emus may be provided by creating and populating the emus directory.
emus may be referenced when composing a honk via colon wrapping. How pleasant.
This :example: will be replaced by emus/example.png.

@ -84,4 +84,3 @@ Specific problem solving instructions are not provided here.
It may be helpful to have a variant of Ping that does perform retries to test
recovery after disconnect.

@ -14,8 +14,6 @@ for administration as well.
The config table contains settings, some of which may not be editable via the
normal interface.
The welcome message on the first page is stored as servermsg.
For development purposes, adding a config value (debug, 1) to the database
will disable caching and hot reload templates. It's not meant to be
harmful in production, just less efficient.
Loading…
Cancel
Save