README (1377B)
1 Simple Learning 2 =============== 3 There are many learning tools out there. There aren't many that were built in a sane way, to aid in learning without getting in the way. This is one of them. The simple learning tool is a web server that renders .sl files containing learning content. 4 5 Specification 6 ============= 7 See docs/sl.sl for the simple learning file format specification. It is loosely based on gemtext. 8 9 Course Layout 10 ============= 11 ├── haskell 12 │ ├── 0_haskell.sl 13 │ └── 1_haskell.sl 14 └── ocaml 15 ├── 0_installation.sl 16 ├── 1.0_better_programming_through_ocaml.sl 17 ├── 1.1_the_past_of_ocaml.sl 18 ├── 1.2_the_present_of_ocaml.sl 19 └── assets 20 ├── em.png 21 └── out.webm 22 23 There are top level directories which are courses. Each course directory must contain .sl files, with an optional assets directory that will be served statically by the web server. 24 25 Requirements 26 ============ 27 opam, dune 28 29 Build 30 ===== 31 Run the following: 32 git clone git://git.laack.co/simple-learning 33 cd simple-learning/learning 34 opam install . --deps-only 35 dune build 36 37 Usage 38 ===== 39 Start a web server, serving courses in {courses_dir}: 40 dune exec learning {courses_dir} 41 42 The above command must be executed from the learning directory because the learning directory contains static assets.