michael/pathfinder
michael
/
pathfinder
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add build instructions

This commit is contained in:
Patrick Walton 2017-02-09 17:40:37 -08:00
parent 96daa32b90
commit 55e1502eb2
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -20,6 +20,18 @@ features:
* Portability to most GPUs manufactured in the last few years, including integrated GPUs. * Portability to most GPUs manufactured in the last few years, including integrated GPUs.
## Building
Check out the code and run `cargo build --release`.
Try the demo with `cargo run --release --example lorem-ipsum -- resources/tests/nimbus-sans/NimbusSanL-Regu.ttf`.
As an alternative, debug builds (without the `--release`) build quickly and are typically fast,
since most of the code runs on GPU.
On Windows, running the demos requires GLFW, which requires CMake to be installed and in your PATH.
Get it from [cmake.org](https://cmake.org/).
## Authors ## Authors
The primary author is Patrick Walton (@pcwalton), with contributions from the Servo development The primary author is Patrick Walton (@pcwalton), with contributions from the Servo development