From 7b7b1db077ac13f99ddcb6e76668b6008d6b69eb Mon Sep 17 00:00:00 2001
From: Arun Isaac
Date: Fri, 26 Feb 2021 16:45:28 +0530
Subject: Add README.

* README.org: New file.
---
 README.org | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 README.org

(limited to 'README.org')

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..5e46260
--- /dev/null
+++ b/README.org
@@ -0,0 +1,22 @@
+#+TITLE: Extent sampling
+
+* Build
+
+Build dependencies are
+- cmake and make (for the build system)
+- sph-sc (to generate C sources from SC sources)
+- indent (optional; to indent the generated sources)
+- guile (for the scheme wrappers)
+
+To build, run the following commands.
+
+#+BEGIN_SRC shell
+  $ cmake -B build
+  $ make -C build
+#+END_SRC
+
+* License
+
+The source code is free software released under the terms of the [[https://www.gnu.org/licenses/gpl.html][GNU
+General Public License]], either version 3 of the License, or (at your
+option) any later version.
-- 
cgit v1.2.3