Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jonsterling committed Dec 28, 2023
1 parent c0c9b53 commit 98bb968
Showing 1 changed file with 1 addition and 6 deletions.
7 changes: 1 addition & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,6 @@ To build this forest, you need to have a working installation of the following s

- `forester`, which you can install using `opam install forester`; at times, you may need to build from [source](https://github.com/jonsterling/ocaml-forester) if I haven't released the latest version to opam

Once you have ensured that these programs are installed and in your `PATH`, simply run `./build.sh`. To view the forest, you can open `output/index.xml` in your favorite browser: for Firefox, you may need to set `security.fileuri.strict_origin_policy` to `false` in `about:config`. Alternatively, you can serve the `output` directory from a local webserver to avoid this. If you have a working `python3` installation, you can run `./server.sh` to continuously build and serve the forest from port `1313`.
Once you have ensured that these programs are installed and in your `PATH`, simply run `./build.sh`. To view the forest, you can open `output/index.xml` in your favorite browser: for Firefox, you may need to set `security.fileuri.strict_origin_policy` to `false` in `about:config`. Alternatively, you can serve the `output` directory from a local webserver to avoid this. If you have a working `python3` installation, you can run `./server.sh` to continuously build and serve the forest from port `1313`.

Alternatively, if you have [`fswatch`](https://github.com/emcrisostomo/fswatch) installed, you can run `./watch.sh` to watch for changes to the `trees` directory and rebuild accordingly.

### JavaScript dependencies

My forest has a small JavaScript component (`javascript/forester.js`), which creates a keyboard command palette. There is no need to have any of the JavaScript or Node ecosystem installed on your machine; all JavaScript dependencies are kept bundled in source control. If you wish to *upgrade* this bundle, you will need to have a working installation of `npm`, and then run `./bundle-js.sh` and commit the resulting changes. It is not ordinarily necessary to do this.

0 comments on commit 98bb968

Please sign in to comment.