summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Thompson <dthompson2@worcester.edu>2013-07-26 19:18:57 -0400
committerDavid Thompson <dthompson2@worcester.edu>2013-07-26 19:18:57 -0400
commit91e7f48a8748996624857bccb894d7f2ebc3ff1c (patch)
tree1e5a575766e21b09a8e25ee6148b0541366cb048
parent1c0a63f82770b5dfdb417cb6f68b85e956caec15 (diff)
Adding "Building" and "Running Examples" sections to README.
-rw-r--r--README.org27
1 files changed, 27 insertions, 0 deletions
diff --git a/README.org b/README.org
index d16fc07..5e0c063 100644
--- a/README.org
+++ b/README.org
@@ -171,6 +171,33 @@
** This section needs to be completed. **
+** Building
+ guile-2d uses the typical GNU build system. First run `autogen.sh`
+ and then do the usual incantations.
+
+ #+BEGIN_SRC sh
+ ./autogen.sh
+ ./configure
+ make
+ sudo make install
+ #+END_SRC
+
+** Running Examples
+ To run an example when guile-2d has been installed:
+
+ #+BEGIN_SRC sh
+ cd examples
+ guile simple.scm
+ #+END_SRC
+
+ To run an example using the not-yet-installed files (useful when
+ developing):
+
+ #+BEGIN_SRC sh
+ cd examples
+ guile -L .. simple.scm
+ #+END_SRC
+
** Dependencies
- [[https://gitorious.org/guile-figl/guile-figl][guile-figl]]