X-Git-Url: https://git.teslayout.com/public/public/public/?a=blobdiff_plain;f=README.md;h=29e3fef4d0072861b2b4c7b1c8feed7810e90643;hb=refs%2Fheads%2Fquick_solution;hp=1e8517451061d6342b3a1c39973f1e1ae09f9e7f;hpb=6dbe157ab584ccb81e9d3edc88fabc38c93c7f3e;p=anna.git diff --git a/README.md b/README.md index 1e85174..29e3fef 100644 --- a/README.md +++ b/README.md @@ -1,59 +1,65 @@ -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 -================ -Based on GIT, hosted on www.bitbucket.org. +## Revision control + +Based on GIT, hosted on http://redmine.teslayout.com 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 -======= -Execute 'scons install' -(install-include-and-lib and install-example, are another aliases for selective installation) +## Install -Uninstall -========= -Execute 'scons uninstall' +Execute 'sudo scons install-include' for only headers +Execute 'sudo scons install-lib' for only libraries +Execute 'sudo scons install-include-and-lib' for headers & libraries +Execute 'sudo scons install-example' for only example binaries/resources +Execute 'sudo scons install' to install the whole suite +## Uninstall +Execute 'sudo 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: +### Pcap: + sudo apt-get install libpcap-dev + +### 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,19 +76,20 @@ 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...): sudo apt-get install libboost-dev sudo apt-get install libboost-test-dev - + Development module is no longer needed, but still unit testing is done through boost. + Pending migration to google test framework.