f53fae166f
- Spelling corrections - Added "Cloning & contributing" to Contributing - Revised commands for filename changes
88 lines
2.7 KiB
Markdown
88 lines
2.7 KiB
Markdown
# Contributing to Logarion
|
|
|
|
Logarions primary aim is to create a note system, which doesn't waste resources.
|
|
The secondary aim is to provide an exemplary OCaml project to demonstrate and promote the language (as it happens with many other "Blogging" systems written in other languages).
|
|
|
|
As part of the secondary aim, the source code needs to written in a way that encourages the language's adoption and the participation to the OCaml developer community.
|
|
|
|
## Starting with OCaml
|
|
|
|
_"OCaml is an industrial strength programming language supporting functional, imperative and object-oriented styles"_ -- https://ocaml.org/
|
|
|
|
OCaml simply rocks.
|
|
|
|
If you are unfamiliar with OCaml, consider starting with these resources:
|
|
|
|
- Install OCaml: https://ocaml.org/docs/install.html
|
|
- Read about OCaml: https://ocaml.org/learn/books.html
|
|
- Ask questions & join the community:
|
|
- Mailing lists: https://ocaml.org/community/
|
|
- IRC: irc://irc.freenode.net/#ocaml (Web client: https://riot.im/app/#/room/#freenode_#ocaml:matrix.org )
|
|
- Reddit: http://www.reddit.com/r/ocaml/
|
|
- Discourse: https://discuss.ocaml.org/
|
|
- .. other: https://ocaml.org/community/
|
|
|
|
## Design principles
|
|
|
|
[Unix philosophy](https://en.wikipedia.org/wiki/Unix_philosophy#Do_One_Thing_and_Do_It_Well)
|
|
|
|
1. System simplicity & interoperability.
|
|
2. Output quality.
|
|
3. Distributed interactivity, like sharing with friends.
|
|
|
|
## Developing & contributing
|
|
|
|
### Clone
|
|
|
|
It is best to [fork Logarion](https://gitlab.com/orbifx/logarion/forks/new) first and clone your fork.
|
|
That way you can submit merge requests for any useful changes.
|
|
|
|
To get the source directly, without forking:
|
|
|
|
```
|
|
git clone https://gitlab.com/orgifx/logarion.git
|
|
```
|
|
|
|
Install dependencies:
|
|
|
|
```
|
|
cd logarion
|
|
pin add logarion . -n
|
|
opam depext --install logarion
|
|
```
|
|
|
|
Build the project:
|
|
|
|
```
|
|
jbuilder build src/logarion_cli.exe src/logarion_webserver.exe
|
|
```
|
|
|
|
This will create `_build/default/src/logarion_cli.exe` (the command line interface) and `_build/default/src/logarion_webserver.exe` (the webserver daemon).
|
|
|
|
### Project structure
|
|
|
|
There are three layers:
|
|
|
|
- notes
|
|
- archive
|
|
- interfaces & intermediate formats
|
|
|
|
### Core
|
|
|
|
- `logarion.ml`: repository related functions (listing, adding/removing, etc). ([src/logarion.ml](https://gitlab.com/orbifx/logarion/blob/master/src/logarion.ml))
|
|
- `note.ml`: parsing from and to note files. ([src/note.ml](https://gitlab.com/orbifx/logarion/blob/master/src/note.ml))
|
|
|
|
### Intermediate formats
|
|
|
|
Converters:
|
|
|
|
- `html.ml`: archive to HTML pages.
|
|
- `atom.ml`: archive to Atom feeds.
|
|
|
|
### Interfaces
|
|
|
|
Programs:
|
|
|
|
- `web.ml`: accessing logarion over HTTP.
|
|
- `command.ml`: interacting with logarion archive with commands, for both interactive and scripted use.
|