Acronym redefinition
[anna.git] / 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 www.bitbucket.org.
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 './scr/git/use-pre-commit.sh'
15
16 Documentation
17 =============
18 Execute 'scons doc'
19
20 Unit tests
21 ==========
22 Execute 'scons test'
23
24 Examples
25 ========
26 Execute 'scons example' to generate example binaries
27
28 Install
29 =======
30 Execute 'scons install'
31 (install-include-and-lib and install-example, are another aliases for selective installation)
32
33 Uninstall
34 =========
35 Execute 'scons uninstall'
36
37
38
39 Some basic ubuntu requirements
40 ==============================
41 * Scons python-based building suite:
42      sudo apt-get install scons
43
44 * OpenSSL:
45      sudo apt-get install libssl-dev
46  
47 * Gnome XML:
48      sudo apt-get install libxml2-dev
49
50 * OpenLDAP:
51      sudo apt-get install libldap2-dev
52
53 * MySql:
54      sudo apt-get install libmysqlclient-dev
55
56 * Oracle:
57      https://help.ubuntu.com/community/Oracle%20Instant%20Client
58      Set 'ORACLE_HOME' environment variable in your profile, i.e.:
59         export ORACLE_HOME=/usr/lib/oracle/12.1/client64/
60
61      Be sure to create in that directory, a link to oracle includes,
62      for example:
63
64         <user>@<host>:/usr/lib/oracle/12.1/client64$ ls -lrt
65         total 8
66         drwxr-xr-x 2 root root 4096 Feb 28 15:59 bin
67         drwxr-xr-x 2 root root 4096 Feb 28 15:59 lib
68         lrwxrwxrwx 1 root root   33 Feb 28 16:07 include -> /usr/include/oracle/12.1/client64
69
70      The alternative is to edit SConstruct file directly to set
71      oracle includes directory.
72
73 * Oracle-OpenLDAP conflict:
74      as usual, Oracle is doing things very bad. Move the ldap.h from oracle includes, i.e.:
75
76         cd /usr/include/oracle/12.1/client64
77         sudo mv ldap.h ldap.h.orig
78
79 * Boost:
80      Although the more i use, the more i dislike, this suite is included (ambition to learn
81      new things...):
82
83         sudo apt-get install libboost-dev
84         sudo apt-get install libboost-test-dev
85
86  
87
88