[Doc] Updated the basic documentation.

Author: da115115

AUTHORS

@@ -0,0 +1,20 @@
+
+* Project Admins (and Developers)
+- Denis Arnaud <[email protected]>
+- Anh Quan Nguyen <[email protected]>
+- Gabrielle Sabatier <[email protected]>
+
+* Retired Developers
+- Daniel Perez <[email protected]>
+- Son Nguyen Kim <[email protected]>
+- Alexandre Point <[email protected]>
+
+* Contributors
+- Emmanuel Bastien <[email protected]>
+
+* Distribution Maintainers
+- Fedora/RedHat:
+ - Denis Arnaud <[email protected]>
+- Debian:
+ - Emmanuel Bastien <[email protected]>
+

README

@@ -0,0 +1,67 @@
+Summary:
+--------
+AirInv is a C++ library of airline inventory management classes and
+functions, mainly targeting simulation purposes.
+
+Airinv makes an extensive use of existing open-source libraries for
+increased functionality, speed and accuracy. In particular the
+Boost (C++ Standard Extensions: http://www.boost.org) library is used.
+
+
+Getting and installing from the Fedora/CentOS/RedHat distribution:
+------------------------------------------------------------------
+Just use Yum:
+yum -y install airinv-devel airinv-doc
+
+You can also get the RPM packages (which may work on Linux
+distributions like Novel Suse and Mandriva) from the Fedora repository
+(e.g., for Fedora 16, 
+http://fr2.rpmfind.net/linux/fedora/releases/16/Everything/)
+
+
+Building the library and test binary from Git repository:
+----------------------------------------------------------------
+The Sourceforge Git repository may be cloned as following:
+git clone ssh://air-sched.git.sourceforge.net/gitroot/air-sched/air-sched airinvgit
+cd airinvgit
+git checkout trunk
+
+Then, you need the following packages (Fedora/RedHat/CentOS names here, 
+but names may vary according to distributions):
+  * cmake
+  * gcc-c++
+  * stdair-devel, airrac-devel, rmol-devel
+  * boost-devel
+  * zeromq-devel
+  * readline-devel
+  * soci-mysql-devel
+  * python-devel
+  * gettext-devel (optional)
+  * doxygen, ghostscript, graphviz and tetex-latex (optional)
+  * rpm-build (optional)
+
+Building the library and test binary from the tarball:
+------------------------------------------------------
+The latest stable source tarball (airinv*.tar.gz or .bz2) can be found here:
+http://sourceforge.net/project/showfiles.php?group_id=261633
+
+Then, as usual:
+* To configure the project, type something like:
+  mkdir build && cd build
+  cmake -DCMAKE_INSTALL_PREFIX=/home/user/dev/deliveries/airinv-0.2.0 \
+   -DWITH_STDAIR_PREFIX=/home/user/dev/deliveries/stdair-stable \
+   -DCMAKE_BUILD_TYPE:STRING=Debug -DINSTALL_DOC:BOOL=ON ..
+* To build the project, type:
+  make
+* To test the project, type:
+  make check
+* To install the library (libairinv*.so*) and the binary (airinv),
+  just type:
+  make install
+* To package the source files, type:
+  make dist
+* To package the binary and the (HTML and PDF) documentation:
+  make package
+
+Denis Arnaud (October 2011)
+