X-Git-Url: https://git.teslayout.com/public/public/public/?p=anna.git;a=blobdiff_plain;f=README.md;h=b9bc6ae28aebfc37fb16f74f9f18c0e442abc919;hp=840e9ac4f7b783fb783f63dfa57add7309fe97da;hb=HEAD;hpb=72687d725ac5a53ff71379f72b0eea0b3451b62b diff --git a/README.md b/README.md index 840e9ac..b9bc6ae 100644 --- a/README.md +++ b/README.md @@ -1,85 +1,146 @@ -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. +# ANNA -Revision control -================ -Based on GIT, hosted on www.bitbucket.org. +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 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' + astyle code processing): Execute './scripts/git/use-pre-commit.sh' + + +## Build project + +### With docker + +Architectures 'x86_64' and 'armv7l' are supported. Execute: + + > tools/build-with-docker [variant: [Release]|Debug] + +Note: database resources building is unsupported at the moment using docker. + +### Natively + +This is a CMake based building suite. +Install cmake: + + > sudo apt-get install cmake + +And then generate the makefiles from project root directory: + + > cmake . + +You could specify type of build, 'Debug' or 'Release', for example: + + > cmake -DCMAKE_BUILD_TYPE=Debug . + > cmake -DCMAKE_BUILD_TYPE=Release . + +You could avoid database resources compilation to ease the add of requirements: + + > cmake -DSKIP_DATABASE_BUILD=1 . -Documentation -============= -Execute 'scons doc' +## Clean project -Unit tests -========== -Execute 'scons test' + > make clean -Examples -======== -Execute 'scons examples' to generate example binaries +## Change the compilers -Install -======= -Execute 'scons install' -(install-include-and-lib and install-example, are another aliases for selective installation) + > cmake -DCMAKE_CXX_COMPILER=/usr/bin/g++ -DCMAKE_C_COMPILER=/usr/bin/gcc + or + > cmake -DCMAKE_CXX_COMPILER=/usr/bin/clang++ -DCMAKE_C_COMPILER=/usr/bin/clang -Uninstall -========= -Execute 'scons uninstall' +## Some basic ubuntu requirements +### OpenSSL: + > sudo apt-get install libssl-dev +### Gnome XML: + > sudo apt-get install libxml2-dev -Some basic ubuntu requirements -============================== -* Scons python-based building suite: - sudo apt-get install scons +### OpenLDAP: + > sudo apt-get install libldap2-dev -* OpenSSL: - sudo apt-get install libssl-dev - -* Gnome XML: - sudo apt-get install libxml2-dev +### Pcap: + > sudo apt-get install libpcap-dev -* OpenLDAP: - sudo apt-get install libldap2-dev +### MySql: + > sudo apt-get install libmysqlclient-dev -* MySql: - sudo apt-get install libmysqlclient-dev +### Oracle: + Go to https://help.ubuntu.com/community/Oracle%20Instant%20Client and download development packages: -* 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/ + For example: - Be sure to create in that directory, a link to oracle includes, - for example: + > wget https://download.oracle.com/otn_software/linux/instantclient/19600/oracle-instantclient19.6-devel-19.6.0.0.0-1.x86_64.rpm + > sudo alien -i oracle-instantclient19.6-devel-19.6.0.0.0-1.x86_64.rpm - @:/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 + (probably basic & sqlplus is also needed) - The alternative is to edit SConstruct file directly to set - oracle includes directory. + Edit CMakeLists.txt and update oracle includes, for example: -* Oracle-OpenLDAP conflict: + > include_directories(/usr/include/oracle//client64/include) + +### 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 + > cd /usr/include/oracle/12.1/client64 + > sudo mv ldap.h ldap.h.orig + +### Google Test Framework: + + > sudo apt-get install libgtest-dev + + Note that this package only install source files. You have to compile the + code yourself to create the necessary library files. These source files + should be located at /usr/src/gtest. Browse to this folder and use cmake + to compile the library: + + > cd /usr/src/gtest + > sudo cmake CMakeLists.txt + > sudo make + + Copy or symlink libgtest.a and libgtest_main.a to your /usr/lib folder: + > sudo cp *.a /usr/lib + +## Documentation + +Execute 'make doc' + + > cd docs/doxygen + > tree -L 1 + + . + ├── Doxyfile + ├── html + ├── latex + └── man + + +## Unit tests + +Execute 'make test' + +## Install + +To install headers, libraries, and examples, execute: + + > sudo make install + +Optionally you could specify another prefix for installation: + + > cmake -DMY_OWN_INSTALL_PREFIX=$HOME/anna-deploy + > make install -* Boost: - Although the more i use, the more i dislike, this suite is included (ambition to learn - new things...): +## Uninstall - sudo apt-get install libboost-dev - sudo apt-get install libboost-test-dev + > cat install_manifest.txt | sudo xargs rm - +## AOTS (Agents-Oriented Testing Setup) +See INSTALL_AOTS.md