From 0c06eed97afb2f4a8b29cba569358dd0dc492ac6 Mon Sep 17 00:00:00 2001 From: Stavros Polymenis Date: Wed, 19 Apr 2017 00:44:12 +0100 Subject: [PATCH] Documents alpha state in README & revises configuration --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2d8dcf1..c729cc9 100644 --- a/README.md +++ b/README.md @@ -15,12 +15,19 @@ There are two publishing modes: ## Install +This software is in alpha development stage, so install it if you know what you are doing. + Make sure you have OCaml >= 4.03. All requirements are available for automatic installation via [OPAM](https://opam.ocaml.org/) opam pin add logarion https://github.com/orbifx/logarion.git opam install logarion +## Configure + +The main configuration file is [logarion.toml](logarion.toml). +For configurating the webserver, see _Web server_ section below. + ## Running Once installed you will have `logarion` for command line control of the repository and `logarion-web` for web access. @@ -29,15 +36,13 @@ Once installed you will have `logarion` for command line control of the reposito Run `logarion --help`. -The archive's configuration is optionally controlled by `logarion.toml` in the directory the server is executed from. - ### Web server +The web server's configuration is optionally controlled by [web.toml](web.toml) in the directory the server is executed from. + Run `logarion-web`, and open a browser to . To post a new article visit . -The web server's configuration is optionally controlled by `web.toml` in the directory the server is executed from. - Optionally install a [sass](http://sass-lang.com/) compiler, like [sassc](http://sass-lang.com/libsass#sassc), and then run `sassc share/sass/main.sass > share/static/main.css`, to generate a stylesheet in `share/static/main.css`, using `share/sass/main.sass`. ## See also