Permalink
Browse files

update readme

  • Loading branch information...
postspectacular committed Aug 13, 2016
1 parent d59c1fc commit d40d2f54619e61dd8ae096f78b5036c07bc19766
Showing with 23 additions and 21 deletions.
  1. +23 −21 README.org
View
@@ -8,6 +8,8 @@
- [[#math][Math]]
- [[#simulation][Simulation]]
- [[#geometry][Geometry]]
- [[#requirements][Requirements]]
- [[#dependencies][Dependencies]]
- [[#examples][Examples]]
- [[#build-all-examples][Build all examples]]
- [[#1d2d-cellular-automata][1D/2D Cellular automata]]
@@ -19,8 +21,6 @@
- [[#polygon-offsetting][Polygon offsetting]]
- [[#verlet-physics][Verlet physics]]
- [[#voronoi][Voronoi]]
- [[#requirements][Requirements]]
- [[#dependencies][Dependencies]]
- [[#build--test][Build & test]]
- [[#build-static-library][Build static library]]
- [[#build-source-x-ref][Build source x-ref]]
@@ -75,6 +75,25 @@ WIP
...
TBD
** Requirements
- [[https://premake.github.io/][Premake5]]
- [[http://www.gnu.org/software/make/][GNU Make]]
- GCC / Clang (w/ C11 support)
- [[https://github.com/emcrisostomo/fswatch][fswatch]] (only needed for =./autotest= runner)
- [[http://emscripten.org][emscripten]] & [[http://nodejs.org][node]] (only needed for asm.js x-compilation via
=./compile= & =./compile-bc=)
- [[http://cscope.sourceforge.net/][cscope]] (only needed for =./browse=)
- [[https://wiki.gnome.org/Projects/LibRsvg][rsvg]] & [[http://ffmpeg.org/][ffmpeg]] (only needed for =./makevideo=)
** Dependencies
The library itself has no 3rd party dependencies. Some of the examples
however use these additional libs:
- [[https://github.com/thi-ng/ct-head][ct-head]] (included as submodule)
- [[https://github.com/nothings/stb][stb_image]] (bundled under =/examples/common=)
- [[http://www.glfw.org/][GLFW3.2+]]
** Examples
*** Build all examples
@@ -144,6 +163,8 @@ make config=release_sse ex-dla && bin/release/ex-dla > assets/dla.svg
[[./assets/glfw01.jpg]]
See [[#dependencies][dependencies]] for details...
#+BEGIN_SRC shell
# build library & example app
make config=release_sse ex-glfw01 && bin/release/ex-glfw01
@@ -262,25 +283,6 @@ bin/release/ex-poisson -b 00ffff -f 0000ff -q 500 -m 2 -x 16 -t assets/iris.jpg
bin/release/ex-voronoi -p -w 757 -h 450 > iris-voronoi.svg
#+END_SRC
** Requirements
- [[https://premake.github.io/][Premake5]]
- [[http://www.gnu.org/software/make/][GNU Make]]
- GCC / Clang (w/ C11 support)
- [[https://github.com/emcrisostomo/fswatch][fswatch]] (only needed for =./autotest= runner)
- [[http://emscripten.org][emscripten]] & [[http://nodejs.org][node]] (only needed for asm.js x-compilation via =./compile=)
- [[http://cscope.sourceforge.net/][cscope]] (only needed for =./browse=)
- [[https://wiki.gnome.org/Projects/LibRsvg][rsvg]] & [[http://ffmpeg.org/][ffmpeg]] (only needed for =./makevideo=)
** Dependencies
The library itself has no 3rd party dependencies. Some of the examples
however use these additional libs:
- [[https://github.com/thi-ng/ct-head][ct-head]] (included as submodule)
- [[https://github.com/nothings/stb][stb_image]] (bundled under =/examples/common=)
- [[http://www.glfw.org/][GLFW3.2+]]
** Build & test
Get further help for autogenerated =Makefile=:

0 comments on commit d40d2f5

Please sign in to comment.