summaryrefslogtreecommitdiff
path: root/README.scons
diff options
context:
space:
mode:
authorJonathan Clark <jon.h.clark@gmail.com>2011-03-24 09:48:04 -0400
committerJonathan Clark <jon.h.clark@gmail.com>2011-03-24 09:48:04 -0400
commitba4f147f84aa0d4623da640a2d0de7e6242a53af (patch)
treeded3a9ed85ef128a5cf239126da28ee3b1a5a3fc /README.scons
parent70d909f695fdb8207ce251bae9e860c3787d7711 (diff)
parentcb8e10b896d4d19a3d7c9b997a74f9bd39a5c714 (diff)
Undo some silly local changes so we can pull
Diffstat (limited to 'README.scons')
-rw-r--r--README.scons21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.scons b/README.scons
new file mode 100644
index 00000000..eb56a666
--- /dev/null
+++ b/README.scons
@@ -0,0 +1,21 @@
+Building cdec with the scons build system:
+
+While we don't build all components of cdec under scons (yet),
+scons makes things much simpler and reliable. Currently,
+building cdec with scons is experimental.
+
+Step-by-step:
+1) Obtain a Python V2.4 or later (you probably already have this)
+2) Download and install Scons v2.0+ from http://www.scons.org/download.php
+ $ wget http://prdownloads.sourceforge.net/scons/scons-2.0.1.tar.gz
+ $ tar -xvzf scons-2.0.1.tar.gz
+ $ cd scons-2.0.1
+ $ python setup.py build
+ $ sudo setup.py install #(if you have root)
+ $ setup.py install --home=~/prefix #(to install to a user-space prefix instead)
+
+3) Run scons. Some examples:
+ $ scons #(just build the decoder)
+ $ scons -j16 #(build using 16 cores)
+ $ scons -h #(get help)
+ $ scons --with-boost=~/prefix #(use ~/prefix as the boost directory)