|
Last change
on this file since 1 was 1, checked in by fox, 9 years ago |
|
initial simple example with omd
|
|
File size:
1.7 KB
|
| Rev | Line | |
|---|
| [1] | 1 | # Logarion
|
|---|
| 2 |
|
|---|
| 3 | Logarion is a [free and open-source][Licence] personal note taking, journaling and publication system; a blog-wiki hybrid.
|
|---|
| 4 |
|
|---|
| 5 | ## Features
|
|---|
| 6 |
|
|---|
| 7 | - Plain file system store, where each note is a file.
|
|---|
| 8 | - Command line & web interfaces.
|
|---|
| 9 | - Atom feeds
|
|---|
| 10 | - Static (conversion to files for uploading) & dynamic serving (HTTP, Gopher, ..).
|
|---|
| 11 |
|
|---|
| 12 |
|
|---|
| 13 | ## Community & support
|
|---|
| 14 |
|
|---|
| 15 | - Website: <https://logarion.orbitalfox.eu>
|
|---|
| 16 | - Mailing list: <https://lists.orbitalfox.eu/listinfo/logarion>
|
|---|
| 17 | - Matrix (chat): `#logarion:matrix.org`. Via Riot web-app: <https://riot.im/app/#/room/#logarion:matrix.org>
|
|---|
| 18 | - For issues peferably email to [mailto:logarion@lists.orbitalfox.eu](mailto:logarion@lists.orbitalfox.eu?subject=[Issue] summary-here).
|
|---|
| 19 | Alternatively <https://gitlab.com/orbifx/logarion/issues>
|
|---|
| 20 |
|
|---|
| 21 |
|
|---|
| 22 | ## Install
|
|---|
| 23 |
|
|---|
| 24 | The following instructions are the quickest way to install Logarion (in the absence of binary releases).
|
|---|
| 25 |
|
|---|
| 26 | ```
|
|---|
| 27 | opam pin add logarion git://orbitalfox.eu/logarion
|
|---|
| 28 | opam install logarion
|
|---|
| 29 | ```
|
|---|
| 30 |
|
|---|
| 31 | Once installed you will have `logarion` for command line control of the repository.
|
|---|
| 32 |
|
|---|
| 33 | ## Archives
|
|---|
| 34 |
|
|---|
| 35 | ### Command line
|
|---|
| 36 |
|
|---|
| 37 | Create a folder and run `logarion init` from within it to produce `.logarion/config.toml`, which is the core configuration file.
|
|---|
| 38 | The archive options are under the `[archive]` section.
|
|---|
| 39 |
|
|---|
| 40 | Run `logarion --help` for more options.
|
|---|
| 41 |
|
|---|
| 42 |
|
|---|
| 43 | #### Theme
|
|---|
| 44 |
|
|---|
| 45 | Optionally install a [Sass](http://sass-lang.com/) compiler, like [sassc](http://sass-lang.com/libsass#sassc), and then run `make theme-dark` or `make theme-light`, to generate a stylesheet as `share/static/main.css`, using the respective Sass files in `share/sass/`.
|
|---|
| 46 |
|
|---|
| 47 | ## See also
|
|---|
| 48 |
|
|---|
| 49 | - [CONTRIBUTING.md](CONTRIBUTING.md)
|
|---|
| 50 | - [Licence](https://joinup.ec.europa.eu/software/page/eupl)
|
|---|
Note:
See
TracBrowser
for help on using the repository browser.
