Updated license

[anna.git] / README.md

diff --git a/README.md b/README.md
index 11d1a2b..1e85174 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,11 +1,17 @@
 ANNA
 ====
-ANNA is the acronym for "ANNA is not 'N' anymore", a complete suite of tools and resources to build proffesional applications with minimum cost.
+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.
 
 Revision control
 ================
 Based on GIT, hosted on www.bitbucket.org.
-Copy or link 'pre-commit.sh' to '.git/hooks/pre-commit' if you want to do some basic checkings (i.e. astyle code processing)
+
+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'
 
 Documentation
 =============
@@ -17,7 +23,7 @@ Execute 'scons test'
 
 Examples
 ========
-Execute 'scons examples' to generate example binaries
+Execute 'scons example' to generate example binaries
 
 Install
 =======
@@ -27,3 +33,56 @@ Execute 'scons install'
 Uninstall
 =========
 Execute 'scons uninstall'
+
+
+
+Some basic ubuntu requirements
+==============================
+* Scons python-based building suite:
+     sudo apt-get install scons
+
+* OpenSSL:
+     sudo apt-get install libssl-dev
+ 
+* Gnome XML:
+     sudo apt-get install libxml2-dev
+
+* OpenLDAP:
+     sudo apt-get install libldap2-dev
+
+* MySql:
+     sudo apt-get install libmysqlclient-dev
+
+* 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.
+
+* 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
+
+* 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
+
+ 
+
+