README.md

   1 # ANNA
   2
   3 Multi-purpose C++ development suite, focused on Telco resources (communications, protocols and tools).
   4 ANNA is acronym for "Anna is not nothingness anymore", that is to say: "Anna is something to take into
   5 account" (like a SONaTINA).
   6
   7 ANNA is a complete suite of tools and resources to build proffesional applications with minimum cost.
   8
   9 ## Revision control
  10
  11 Based on GIT, hosted on http://redmine.teslayout.com
  12
  13 You could use my pre-commit specific template if you want to do some basic checkings (i.e.
  14  astyle code processing): Execute './scripts/git/use-pre-commit.sh'
  15
  16
  17 ## Build project
  18
  19 This is a CMake based building suite.
  20 Install cmake:
  21
  22      > sudo apt-get install cmake
  23
  24 And then generate the makefiles from project root directory:
  25
  26      > cmake .
  27
  28 You could specify type of build, 'Debug' or 'Release', for example:
  29
  30      > cmake -DCMAKE_BUILD_TYPE=Debug .
  31      > cmake -DCMAKE_BUILD_TYPE=Release .
  32
  33 ## Clean project
  34
  35      > make clean
  36
  37 ## Change the compilers
  38
  39      > cmake -DCMAKE_CXX_COMPILER=/usr/bin/g++     -DCMAKE_C_COMPILER=/usr/bin/gcc
  40      or
  41      > cmake -DCMAKE_CXX_COMPILER=/usr/bin/clang++ -DCMAKE_C_COMPILER=/usr/bin/clang
  42
  43 ## Some basic ubuntu requirements
  44
  45 ### OpenSSL:
  46      > sudo apt-get install libssl-dev
  47
  48 ### Gnome XML:
  49      > sudo apt-get install libxml2-dev
  50
  51 ### OpenLDAP:
  52      > sudo apt-get install libldap2-dev
  53
  54 ### Pcap:
  55      > sudo apt-get install libpcap-dev
  56
  57 ### Google Test Framework:
  58
  59      > sudo apt-get install libgtest-dev
  60
  61      Note that this package only install source files. You have to compile the
  62      code yourself to create the necessary library files. These source files
  63      should be located at /usr/src/gtest. Browse to this folder and use cmake
  64      to compile the library:
  65
  66      > cd /usr/src/gtest
  67      > sudo cmake CMakeLists.txt
  68      > sudo make
  69
  70      Copy or symlink libgtest.a and libgtest_main.a to your /usr/lib folder:
  71      > sudo cp *.a /usr/lib
  72
  73 ## Documentation
  74
  75 Execute 'make doc'
  76
  77      > cd docs/doxygen
  78      > tree -L 1
  79
  80      .
  81      ├── Doxyfile
  82      ├── html
  83      ├── latex
  84      └── man
  85
  86
  87 ## Unit tests
  88
  89 Execute 'make test'
  90
  91 ## Install
  92
  93 To install headers, libraries, and examples, execute:
  94
  95      > sudo make install
  96
  97 Optionally you could specify another prefix for installation:
  98
  99      > cmake -DMY_OWN_INSTALL_PREFIX=$HOME/anna-deploy
 100      > make install
 101
 102 ## Uninstall
 103
 104      > cat install_manifest.txt | sudo xargs rm
 105
 106