From 3e748eab44e600cce290e8a2ec251e63a0f0eeb0 Mon Sep 17 00:00:00 2001
From: Arun Isaac
Date: Fri, 26 Feb 2021 19:50:45 +0530
Subject: Document running of examples in README.

* README.org (Usage): New section.
---
 README.org | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'README.org')

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
-- 
cgit v1.2.3