Repository navigation
Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
Repository files navigation
Simple Learning
===============
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.
Specification
=============
See docs/sl.sl for the simple learning file format specification. It is loosely based on gemtext.
Course Layout
=============
├── haskell
│ ├── 0_haskell.sl
│ └── 1_haskell.sl
└── ocaml
├── 0_installation.sl
├── 1.0_better_programming_through_ocaml.sl
├── 1.1_the_past_of_ocaml.sl
├── 1.2_the_present_of_ocaml.sl
└── assets
├── em.png
└── out.webm
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.
Requirements
============
opam, dune
Build
=====
Run the following:
git clone git://git.laack.co/simple-learning
cd simple-learning/learning
opam install . --deps-only
dune build
Usage
=====
Start a web server, serving courses in {courses_dir}:
dune exec learning {courses_dir}
The above command must be executed from the learning directory because the learning directory contains static assets.