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

revised documentation

Browse Source
This commit is contained in:
Stavros Polymenis 2017-03-13 23:07:21 +00:00
parent 21de0ceefb
commit a68a181b0e
2 changed files with 39 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
CONTRIBUTING.md
View File

@ -1,18 +1,32 @@
# Contributing to Logarion
There are three layers: the YMD format, the repository system, and the outlets.
There are three layers: the file format, the repository system, and the outlets.
ymd.ml <--> logarion.ml <--> intermediate formats <--> programs
Design principles:
1. System simplicity & interoperability.
2. Output quality.
3. Distributed interactivity, like sharing with friends.
## Source
### Core
- `src/ymd.ml`: parsing from and to YMD files.
- `src/logarion.ml`: repository related functions (listing, adding/removing, etc).
- `logarion.ml`: repository related functions (listing, adding/removing, etc).
- `ymd.ml`: parsing from and to YMD files.
### Intermediate formats
- `src/html.ml`: conversions of articles and listings to HTML pages
Converters:
- `html.ml`: archive to HTML pages.
- `atom.ml`: archive to Atom feeds.
### Interfaces
- `src/web.ml`: a program for accessing logarion over HTTP
Programs:
- `web.ml`: accessing logarion over HTTP.
- `command.ml`: interacting with logarion archive with commands, for both interactive and scripted use.

42
README.md
View File

@ -2,19 +2,10 @@
## Summary
_(Note: the following summary is a specification, not everything described is complete)_
Logarion is a personal note taking, journaling and publication system, a hybrid between a "Blog" and a "Wiki".
There is a command line archive interface, a graphical user interface (coming soon) and a web server.
Logarion is a personal journaling and publication system.
The suite provides a command line archive interface, a graphical user interfance (coming soon) and a web server.
Design principles:
1. System simplicity & interoperability.
2. Output quality.
3. Distributed interactivity, like sharing with friends.
Logarions articles are stored as plain text Yamado files (`.ymd`).
_YMD_ files can be stored internally and controlled by Logarion, or they can be piped from other sources.
Notes are stored as plain text files.
There are two publishing modes:
@ -28,21 +19,28 @@ There are two publishing modes:
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
git clone git@github.com:orbifx/logarion.git
cd logarion
make opam.dependencies
make dirs
make
## Running
Optionally install a [sass](http://sass-lang.com/) compiler, like [sassc](http://sass-lang.com/libsass#sassc), and then run `make style` will generate a stylesheet in `share/static/main.css`, using `share/sass/main.sass`.
Once installed you will have `logarion` for command line control of the repository and `logarion-web` for web access.
This should generate `web`. Run with:
### Command line
web
Run `logarion --help`.
and open a browser to <http://localhost:3000>.
To post a new article visit <http://localhost:3000/new>.
The archive's configuration is optionally controlled by `logarion.toml` in the directory the server is executed from.
### Web server
Run `logarion-web`, and open a browser to <http://localhost:3666>.
To post a new article visit <http://localhost:3666/new.note>.
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