From 6a622b7f048d8d959bc63ee18ba1951ea5286bee Mon Sep 17 00:00:00 2001 From: Rob Eisenberg Date: Wed, 26 Sep 2018 10:46:28 -0700 Subject: [PATCH] doc(readme): clarify demo build requirements My normal workflow involves using tools that are mostly in "JavaScript land". So, I didn't have either Rust or CMake installed. The instructions mentioned Rust nightly builds as a dependency, but not CMake. So, I've added CMake and then turned each of these dependencies into a link as a convenience for anyone that comes along later. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e513616f..37d5c6c0 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ Pathfinder 2 is a set of modular packages, allowing you to choose which parts of need. A WebGL demo is included, so you can try Pathfinder right in your browser. (Please note that, like the rest of Pathfinder, it's under heavy development and has known bugs.) -To run the demo, make sure NPM and nightly Rust are installed, and run the following commands: +To run the demo, make sure [Node.js](https://nodejs.org/en/), [nightly Rust](https://doc.rust-lang.org/1.5.0/book/nightly-rust.html) and [CMake](https://cmake.org/install/) are installed, then run the following commands: $ cd demo/client $ npm install