From d721d5cb3703efd83e98ee8def94041d9a97df6e Mon Sep 17 00:00:00 2001 From: Kento Okura Date: Thu, 16 Jan 2025 16:25:42 +0100 Subject: [PATCH] more documentation --- docs/developing.mld | 22 ++++++++++++++++++++++ docs/index.mld | 16 ++++++++++++++++ 2 files changed, 38 insertions(+) create mode 100644 docs/developing.mld create mode 100644 docs/index.mld diff --git a/docs/developing.mld b/docs/developing.mld new file mode 100644 index 0000000..fb38515 --- /dev/null +++ b/docs/developing.mld @@ -0,0 +1,22 @@ +{0 Developing Forester} + +{1 Questions} + +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. + +{1 Getting started} + +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}. + +{2 Building the project} + +[dune build] + +{2 Testing} + +Use [dune runtest] to run the test suite. We have added testing only recently, + +{2 Sending a patch} + +Once your changes are ready, follow {{: https://lists.sr.ht/~jonsterling/forester-devel}these instructions} to submit them for review. + diff --git a/docs/index.mld b/docs/index.mld new file mode 100644 index 0000000..1751bd6 --- /dev/null +++ b/docs/index.mld @@ -0,0 +1,16 @@ +{0 Forester: A language for scientific hypertext} + +{1 Introduction} + +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. + +{1 Codebase overview} + +The code is organized into several libraries: + +{!modules: + Forester_prelude + Forester_core + Forester_compiler + Forester_frontend + Forester_lsp} -- 2.51.2