software-archive/logarion-2016
2
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Correct readme

Browse Source
This commit is contained in:
Stavros Polymenis 2017-10-01 21:03:24 +01:00
parent f53fae166f
commit 49ece25552
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -25,7 +25,9 @@ Two publishing modes:
## Install
For development instructions see [CONTRIBUTING.md]
For development instructions see [CONTRIBUTING.md](CONTRIBUTING.md#developing-contributing).
The following instructions are the quickest way to install Logarion (in the absense of binary releases).
```
opam pin add logarion https://gitlab.com/orbifx/logarion.git
@ -43,13 +45,13 @@ Once installed you will have `logarion_cli` for command line control of the repo
### Command line
Run `logarion --help`.
Run `logarion_cli --help`.
### 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_webserver`, and open a browser to <http://localhost:3666>.
Run `logarion_webserver` and open a browser to <http://localhost:3666>.
To post a new article visit <http://localhost:3666/new.note>.
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`.