Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 2.43 KB

README.md

File metadata and controls

31 lines (21 loc) · 2.43 KB

Plurigrid Forest

If a tree cascades in a Corola forest, does it trace a Riemannian manifold? - IngSoc

Stochastic parasitics with high-quality mathematical typesetting.

See here for a very quick tour of Forest (and its LocalCharts incarnation).

Setup Instructions

  1. Install nix. The best way to do this if you don't already have nix installed is via the Determinate Nix installer. If you are on macOS, you can do this without even going into Terminal.app, with the Graphical Nix Installer.
  2. Clone this repository with git clone https://github.com/LocalCharts/forest, or if you have an SSH key on github, git clone [email protected]:LocalCharts/forest.
  3. Move into the directory you cloned into with cd forest

Here you have two choices:

  1. The way G-d intended (standard but longer, involves downloading and installing 2GB+ of stuff):

    This step might take a while the first time as it installs OCaml, TeXlive, and the automatically refreshing preview server.

    1. Run nix --extra-experimental-features nix-command --extra-experimental-features flakes develop.
    2. Run forester-dev. This will start a server at http://localhost:8080 which serves the built version of the forest. Note that if you go to http://localhost:8080 you will get a blank screen; you have to go to http://localhost:8080/index.xml to get the main page, or http://localhost:8080/namespace-XXXX.xml for looking at other pages.

  2. The shortcut (less standard but quicker, recommended if you don't use Nix otherwise):

    In this case you must have a recent TeXlive installation on your computer.

    1. Run nix --extra-experimental-features nix-command --extra-experimental-features flakes develop '.#shell-minimal', which only contains forester and the new and build wrapper commands.
    2. Run build to build the site into the output/ directory, and then run serve to start up a server to preview the output; you can then go to http://localhost:8080/index.xml as in the previous instructions.

Now you can go and edit some files in the trees/ directory! For a general reference on forester syntax, see The Forester markup language.

Contributing

You can send PRs to either github