aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArun Isaac2021-02-26 19:50:45 +0530
committerArun Isaac2021-02-26 19:50:45 +0530
commit3e748eab44e600cce290e8a2ec251e63a0f0eeb0 (patch)
treef8baeb62b1ebb7574e4cdd143c2efa2246107986
parent0cfa01c973b6ead3b8a8d4dd84f2d28ece0bac04 (diff)
downloadnsmc-3e748eab44e600cce290e8a2ec251e63a0f0eeb0.tar.gz
nsmc-3e748eab44e600cce290e8a2ec251e63a0f0eeb0.tar.lz
nsmc-3e748eab44e600cce290e8a2ec251e63a0f0eeb0.zip
Document running of examples in README.
* README.org (Usage): New section.
-rw-r--r--README.org12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.org b/README.org
index f5d6960..12853d2 100644
--- a/README.org
+++ b/README.org
@@ -23,6 +23,18 @@ To build, run the following commands.
$ make -C build
#+END_SRC
+* Usage
+
+See examples in the /examples/ directory. You can build and run them,
+for example, using the following commands. /pre-inst-env/ is a shell
+wrapper that sets the necessary environment variables so that headers
+and dynamic libraries are found correctly.
+
+#+BEGIN_SRC shell
+ $ ./build/pre-inst-env gcc -lgsl -lgslcblas -lnsmc examples/generate-cone-vector.c -o generate-cone-vector
+ $ ./build/pre-inst-env ./generate-cone-vector
+#+END_SRC
+
* License
The source code is free software released under the terms of the [[https://www.gnu.org/licenses/gpl.html][GNU