Robin.Malley
/
smr
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update readme

This commit is contained in:
Robin Malley 2020-12-23 07:14:56 +00:00
parent a144c25ab8
commit 0fd5096562
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -15,11 +15,23 @@ be small, fast, and secure. It is built on top of [Kore](https://kore.io), using
* Comments (complete) * Comments (complete)
* Tags (complete) * Tags (complete)
* Author biographies * Author biographies
* Search
* Archive
## Hacking ## Hacking
If you want to contribute to this repository: 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 <package>`)
* 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. ## Misc notes.