From 0fd50965622d092a813ad21b69d6beb2138ec6e3 Mon Sep 17 00:00:00 2001 From: Robin Malley Date: Wed, 23 Dec 2020 07:14:56 +0000 Subject: [PATCH] Update readme --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dc2357c..b9b7843 100644 --- a/README.md +++ b/README.md @@ -15,11 +15,23 @@ be small, fast, and secure. It is built on top of [Kore](https://kore.io), using * Comments (complete) * Tags (complete) * Author biographies +* Search +* Archive ## Hacking If you want to contribute to this repository: -1. Install the [kore webserver](https://kore.io) Documentation -> installation +1. Install the [kore webserver](https://kore.io)(Documentation -> installation) +2. Use a `kodev create smr` to create a blank kore application +3. Install Lua and Luarocks from your package manager +4. Use Luarocks to install the following dependencies (`luarocks install `) + * etlua - Lua templating, comparable to Jinja for Python + * lpeg - Parsing Expression Grammers, used to build text parsers + * lsqlite3 - Sqlite3 for Lua, a lightweight database + * lua-zlib - Data compression +5. You may need to modify conf/build.conf, I use Lua 5.1 on my development machine, + but everything should still work with later versions. +6. Clone this repository into the smr folder, cd into the root, and run `make`! ## Misc notes.