From e85b634ac909b46b4180321993a3395353b71c83 Mon Sep 17 00:00:00 2001
From: manojgudi
Date: Sat, 28 Dec 2013 03:38:55 +0530
Subject: Added quick build guide
---
README.md | 66 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
README.txt | 32 ------------------------------
2 files changed, 66 insertions(+), 32 deletions(-)
create mode 100644 README.md
delete mode 100644 README.txt
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d26063d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,66 @@
+Sandhi
+----
+
+Sandhi is a visual programming software particularly for control systems. Sandhi is forked from GNU Radio project which uses GRAS (GNU Radio Advanced Scheduler) https://github.com/guruofquality/gras/wiki
+
+# Quick Build Guide
+
+## Dependencies
+Sandhi is conglomeration of lot of libraries and softwares. It uses GNU Radio at its core. For computational purposes, Scilab and Octave can be interfaced with Sandhi. Sandhi uses a special wrapper called Sciscipy which allows one to call scilab functions from python without having to worry about datatype conversion.
+
+---------------------------
+### Installing GNU Radio dependencies
+
+*If on Ubuntu 12.04, one can directly install using command*-
+
+
+`sudo apt-get -y install git-core autoconf automake libtool g++ python-dev swig \
+pkg-config libboost1.48-all-dev libfftw3-dev libcppunit-dev libgsl0-dev \
+libusb-dev sdcc libsdl1.2-dev python-wxgtk2.8 python-numpy \
+python-cheetah python-lxml doxygen python-qt4 python-qwt5-qt4 libxi-dev \
+libqt4-opengl-dev libqwt5-qt4-dev libfontconfig1-dev libxrender-dev`
+
+*Please note that Sandhi has been known to **not** work libboost1.49 available in Ubuntu 12.10
+
+-------------------------
+### Sciscipy
+Sciscipy is a must for Sandhi's control blocks to work; to install:
+
+> Clone sciscipy-1.0.0 from our repository
+`git clone https://github.com/manojgudi/sciscipy-1.0.0.git`
+
+> Run _install_ script from the directory with sudo privileges to automatically pull all dependencies for Sciscipy, build and install it.
+`sudo ./install`
+
+
+
+-------------------------------------------------------------------------
+Get the source code
+-------------------------------------------------------------------------
+
+ git clone http://github.com/manojgudi/sandhi.git
+ cd sandhi/
+ git submodule init
+ git submodule update
+
+-- UPDATING FROM EXISTING CHECKOUT --
+
+
+ cd sandhi/
+ git pull origin master
+ git submodule update
+
+------------------------------------------------------------------------
+Build and Install instructions
+------------------------------------------------------------------------
+
+ cd sandhi/
+ mkdir build
+ cd build/
+ cmake ../
+ make -j 2
+ sudo make install
+ sudo ldconfig
+
+
+
diff --git a/README.txt b/README.txt
deleted file mode 100644
index e43cc21..0000000
--- a/README.txt
+++ /dev/null
@@ -1,32 +0,0 @@
-Sandhi
----------
-
-Sandhi is a visual programming software particularly for control systems. Sandhi is forked from GNU Radio project which uses GRAS (GNU Radio Advanced Scheduler) https://github.com/guruofquality/gras/wiki
-
-
-# Dependencies
-Sandhi is conglomeration of lot of libraries and softwares. For computational purposes, Scilab and Octave can be interfaced with Sandhi. Sandhi uses a special wrapper called Sciscipy which alllows one to call scilab functions from python without having to worry about datatype conversion.
-
-To build Sandhi, following dependencies have to be met-
-
-
-If on Ubuntu one can directly install using command*-
-
-
-Sciscipy is a must for Sandhi's control blocks to work; To install:
-1. Clone sciscipy-1.0.0 from our repository
-`git clone https://github.com/manojgudi/sciscipy-1.0.0.git`
-
-2. Run _install_ script from the directory with sudo privileges to automatically pull all dependencies for Sciscipy, build and install it.
-`sudo ./install`
-
-*Please note that Sandhi has been known to *not* work libboost1.49 available in Ubuntu 12.10
-
-# Build Guide
-
-
-
-# Road Map
-
-
-
--
cgit