From 3b3b8391d183ab368941a692062815a77fa7b902 Mon Sep 17 00:00:00 2001 From: Eduardo Ramos Testillano Date: Sat, 6 Dec 2014 21:52:00 +0100 Subject: [PATCH] Fix to markdown --- README.md | 48 ++++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 1e85174..c41ea3c 100644 --- a/README.md +++ b/README.md @@ -1,59 +1,59 @@ -ANNA -==== +# 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. -Revision control -================ +## 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' -Documentation -============= +## Documentation + Execute 'scons doc' -Unit tests -========== +## Unit tests + Execute 'scons test' -Examples -======== +## Examples + Execute 'scons example' to generate example binaries -Install -======= +## Install + Execute 'scons install' (install-include-and-lib and install-example, are another aliases for selective installation) -Uninstall -========= +## Uninstall + Execute 'scons uninstall' -Some basic ubuntu requirements -============================== -* Scons python-based building suite: +## Some basic ubuntu requirements + +### Scons python-based building suite: sudo apt-get install scons -* OpenSSL: +### OpenSSL: sudo apt-get install libssl-dev -* Gnome XML: +### Gnome XML: sudo apt-get install libxml2-dev -* OpenLDAP: +### OpenLDAP: sudo apt-get install libldap2-dev -* MySql: +### MySql: sudo apt-get install libmysqlclient-dev -* Oracle: +### 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/ @@ -70,13 +70,13 @@ Some basic ubuntu requirements The alternative is to edit SConstruct file directly to set oracle includes directory. -* Oracle-OpenLDAP conflict: +### 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: +### Boost: Although the more i use, the more i dislike, this suite is included (ambition to learn new things...): -- 2.20.1