Portability issues, README.md improved with Ubuntu requirements to make easier the...
[anna.git] / README.md
1 ANNA
2 ====
3 ANNA is the acronym for "ANNA is not 'N' anymore", a complete suite of tools and resources
4  to build proffesional applications with minimum cost.
5
6 Revision control
7 ================
8 Based on GIT, hosted on www.bitbucket.org.
9
10 You could use my pre-commit specific template if you want to do some basic checkings (i.e.
11  astyle code processing): Execute './scr/git/use-pre-commit.sh'
12
13 Documentation
14 =============
15 Execute 'scons doc'
16
17 Unit tests
18 ==========
19 Execute 'scons test'
20
21 Examples
22 ========
23 Execute 'scons examples' to generate example binaries
24
25 Install
26 =======
27 Execute 'scons install'
28 (install-include-and-lib and install-example, are another aliases for selective installation)
29
30 Uninstall
31 =========
32 Execute 'scons uninstall'
33
34
35
36 Some basic ubuntu requirements
37 ==============================
38 * Scons python-based building suite:
39      sudo apt-get install scons
40
41 * OpenSSL:
42      sudo apt-get install libssl-dev
43  
44 * Gnome XML:
45      sudo apt-get install libxml2-dev
46
47 * OpenLDAP:
48      sudo apt-get install libldap2-dev
49
50 * MySql:
51      sudo apt-get install libmysqlclient-dev
52
53 * Oracle:
54      https://help.ubuntu.com/community/Oracle%20Instant%20Client
55      Set 'ORACLE_HOME' environment variable in your profile, i.e.:
56         export ORACLE_HOME=/usr/lib/oracle/12.1/client64/
57
58      Be sure to create in that directory, a link to oracle includes,
59      for example:
60
61         <user>@<host>:/usr/lib/oracle/12.1/client64$ ls -lrt
62         total 8
63         drwxr-xr-x 2 root root 4096 Feb 28 15:59 bin
64         drwxr-xr-x 2 root root 4096 Feb 28 15:59 lib
65         lrwxrwxrwx 1 root root   33 Feb 28 16:07 include -> /usr/include/oracle/12.1/client64
66
67      The alternative is to edit SConstruct file directly to set
68      oracle includes directory.
69
70 * Oracle-OpenLDAP conflict:
71      as usual, Oracle is doing things very bad. Move the ldap.h from oracle includes, i.e.:
72
73         cd /usr/include/oracle/12.1/client64
74         sudo mv ldap.h ldap.h.orig
75
76 * Boost:
77      Although the more i use, the more i dislike, this suite is included (ambition to learn
78      new things...):
79
80         sudo apt-get install libboost-dev
81         sudo apt-get install libboost-test-dev
82
83  
84
85