Skip to content

Latest commit

 

History

History
20 lines (16 loc) · 1.06 KB

README.md

File metadata and controls

20 lines (16 loc) · 1.06 KB
Raw

Documentation for the Lurch project

View it online here.

Structure of this repository:

  • docs/ folder: Where the Markdown source files for the website reside.
  • site/ folder: The compiled output of those Markdown source files is placed into this folder as a static HTML site, and this is what users see online.
  • apidocs/ folder: Contains HTML pages documenting our source code, which lives in another repository
    • apidocs/core/ documents the foundational classes for the project
    • apidocs/engine/ documents the validation algorithm
    • apidocs/app/ documents the code for the user interface
  • build-docs/ folder: Contains scripts that can be run from the command line to rebuild the contents of the apidocs/ folder (and all subfolders)
  • index.html file: A simple HTTP redirect that sends anyone who visits lurchmath.github.io immediately into the site subfolder at lurchmath.github.io/site.