- Recommended OS: Linux Ubuntu 14.04.4 LTS 64-bit
- Dependencies:
g++
, git
, doxygen
, make
- Generate documentation:
doxygen
, texlive
, abntex
, texlive-latex-extra
, texlive-lang-portuguese
, texlive-math-extra
$ sudo apt-get install build-essential git make
$ sudo apt-get install doxygen texlive abntex texlive-latex-extra texlive-lang-portuguese texlive-math-extra
- Setup system environment variables
- The path
$HOME/Workspace
is relative to your system
$ export COMPENDIUM_PROJECT_PATH=$HOME/Workspace/compendium/
$ sudo sed "/COMPENDIUM_PROJECT_PATH/ d" -i /etc/profile
$ sudo sed "\$aCOMPENDIUM_PROJECT_PATH=$COMPENDIUM_PROJECT_PATH" -i /etc/profile
$ mkdir -p $COMPENDIUM_PROJECT_PATH
$ cd $COMPENDIUM_PROJECT_PATH
$ git clone https://github.com/icaromag/compendium-lib
- Run the following commands
$ cd $COMPENDIUM_PROJECT_PATH/compendium-lib/
$ make
$ sudo make install
- To generate documentation using doxygen
$ cd $COMPENDIUM_PROJECT_PATH/compendium-lib/
$ make doc
# open documentation in html format
$ firefox ./doc/html/index.html
# open documentation in pdf format
$ gnome-open ./doc/latex/refman.pdf
- To use the shared library add the following flags to the compiler
-I /usr/local/include/compendium/core/ -L /usr/local/lib/compendium/core/ -lcompendium main.cpp -o a.out
- Include the library header in your
cpp
source code
$ cd $COMPENDIUM_PROJECT_PATH/compendium-lib/
$ make build
$ make run