forked from
jonmsterling.com/ocaml-forester
ocaml
more documentation
authored by
Kento Okura
and committed by
Jon Sterling
d721d5cb
b1eefc02
+38
+22
docs/developing.mld
+22
docs/developing.mld
···
1
+
{0 Developing Forester}
2
+
3
+
{1 Questions}
4
+
5
+
If you have questions, feel free to write an email to [https://lists.sr.ht/~jonsterling/forester-discuss]. Please employ {{: https://useplaintext.email/#etiquette} plaintext email etiquette}, including line wrapping.
6
+
7
+
{1 Getting started}
8
+
9
+
Forester is implementend in the {{: https://ocaml.org/}OCaml programming language}, so you will need to have the OCaml toolchain installed. You can find instructions {{: https://ocaml.org/install#linux_mac_bsd}here}. Alternatively, you can get access to the toolchain using the {{: https://nixos.org/}Nix package manager}.
10
+
11
+
{2 Building the project}
12
+
13
+
[dune build]
14
+
15
+
{2 Testing}
16
+
17
+
Use [dune runtest] to run the test suite. We have added testing only recently,
18
+
19
+
{2 Sending a patch}
20
+
21
+
Once your changes are ready, follow {{: https://lists.sr.ht/~jonsterling/forester-devel}these instructions} to submit them for review.
22
+
+16
docs/index.mld
+16
docs/index.mld
···
1
+
{0 Forester: A language for scientific hypertext}
2
+
3
+
{1 Introduction}
4
+
5
+
Forester is a compiled markup language for authoring scientific hypertext. This documentation is intended to give an overview of forester internals for people interested in contributing to the project.
6
+
7
+
{1 Codebase overview}
8
+
9
+
The code is organized into several libraries:
10
+
11
+
{!modules:
12
+
Forester_prelude
13
+
Forester_core
14
+
Forester_compiler
15
+
Forester_frontend
16
+
Forester_lsp}