From: Eduardo Ramos Testillano <eduardo.ramos.testillano@gmail.com>
Date: Sat, 6 Dec 2014 21:00:22 +0000 (+0100)
Subject: README in textile format
X-Git-Tag: REFACTORING_TESTING_LIBRARY~237
X-Git-Url: https://git.teslayout.com/public/public/public/?a=commitdiff_plain;h=815b6f3b22de10e9c08ed884436abb61dd32ff89;hp=3b3b8391d183ab368941a692062815a77fa7b902;p=anna.git

README in textile format
---

diff --git a/README.textile b/README.textile
new file mode 100644
index 0000000..35b3ba9
--- /dev/null
+++ b/README.textile
@@ -0,0 +1,88 @@
+h1. ANNA
+
+Multi-purpose C++ development suite, focused on Telco resources (communications, protocols and tools).
+ANNA is acronym for "Anna is not nothingness anymore", that is to say: "Anna is something to take into
+account" (like a SONaTINA).
+
+ANNA is a complete suite of tools and resources to build proffesional applications with minimum cost.
+
+h2. Revision control
+
+Based on GIT, hosted on www.bitbucket.org.
+
+You could use my pre-commit specific template if you want to do some basic checkings (i.e.
+ astyle code processing): Execute './scr/git/use-pre-commit.sh'
+
+h2. Documentation
+
+Execute 'scons doc'
+
+h2. Unit tests
+
+Execute 'scons test'
+
+h2. Examples
+
+Execute 'scons example' to generate example binaries
+
+h2. Install
+
+Execute 'scons install'
+(install-include-and-lib and install-example, are another aliases for selective installation)
+
+h2. Uninstall
+
+Execute 'scons uninstall'
+
+
+
+h2. Some basic ubuntu requirements
+
+h3. Scons python-based building suite:
+     sudo apt-get install scons
+
+h3. OpenSSL:
+     sudo apt-get install libssl-dev
+ 
+h3. Gnome XML:
+     sudo apt-get install libxml2-dev
+
+h3. OpenLDAP:
+     sudo apt-get install libldap2-dev
+
+h3. MySql:
+     sudo apt-get install libmysqlclient-dev
+
+h3. Oracle:
+     https://help.ubuntu.com/community/Oracle%20Instant%20Client
+     Set 'ORACLE_HOME' environment variable in your profile, i.e.:
+        export ORACLE_HOME=/usr/lib/oracle/12.1/client64/
+
+     Be sure to create in that directory, a link to oracle includes,
+     for example:
+
+	<user>@<host>:/usr/lib/oracle/12.1/client64$ ls -lrt
+	total 8
+	drwxr-xr-x 2 root root 4096 Feb 28 15:59 bin
+	drwxr-xr-x 2 root root 4096 Feb 28 15:59 lib
+	lrwxrwxrwx 1 root root   33 Feb 28 16:07 include -> /usr/include/oracle/12.1/client64
+
+     The alternative is to edit SConstruct file directly to set
+     oracle includes directory.
+
+h3. Oracle-OpenLDAP conflict:
+     as usual, Oracle is doing things very bad. Move the ldap.h from oracle includes, i.e.:
+
+        cd /usr/include/oracle/12.1/client64
+        sudo mv ldap.h ldap.h.orig
+
+h3. Boost:
+     Although the more i use, the more i dislike, this suite is included (ambition to learn
+     new things...):
+
+        sudo apt-get install libboost-dev
+        sudo apt-get install libboost-test-dev
+
+ 
+
+