diff --git a/README.md b/README.md index b0c5bae90989a979934ee2d4f3684d725716d9d0..b606dc6c8a120484ac1d14758b49624b7602a764 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -dynamic-graph-python -==================== +# dynamic-graph-python [](https://travis-ci.org/stack-of-tasks/dynamic-graph-python) [](https://gitlab.laas.fr/stack-of-tasks/dynamic-graph-python/commits/master) @@ -14,52 +13,19 @@ submodules][git-submodules]. Please clone this repository using the repository, you can run `git submodule init && git submodule update` to retrieve the submodules. +## Documentation -Documentation -------------- +[Online](https://gepettoweb.laas.fr/doc/stack-of-tasks/dynamic-graph-python/master/doxygen-html/) -To get started with this library, please read the [online Doxygen -documentation][doxygen-documentation]. -It can also be generated locally by running the `make doc` -command. After the package is installed, the documentation will be -located in the `$prefix/share/doc/dynamic-graph` directoy where -`$prefix` is your installation prefix (`/usr/local` by default). - - -Getting Help ------------- +## Getting Help Support is provided through: - * the HPP mailing-list: hpp@laas.fr - * the following HipChat room: http://www.hipchat.com/gh4wQrZeV - - -How can I install dynamic-graph? --------------------------------- - -### Installing dependencies - -The matrix abstract layer depends on several packages which -have to be available on your machine. - - - Libraries: - - [Boost][] (>= 1.40) - Its detection is controled by the `BOOST_ROOT` variable, see next section - for more information. - - [Lapack][] library - Use the generic purpose `CMAKE_CXX_FLAGS` and `CMAKE_EXE_LINKER_FLAGS` - to insert the flags required for the compiler to find your Lapack library - if it is installed in a non-standard directory. - - [jrl-mal][] library - - [dynamic-graph][] library - - System tools: - - [CMake][] (>=2.6) - - [pkg-config][] - - usual compilation tools (GCC/G++, make, etc.) - If you are using Ubuntu, these tools are gathered in the `build-essential` package. + * the [issue tracker](https://github.com/stack-of-tasks/dynamic-graph-python/issues) + * the matrix room [#stack-of-tasks:laas.fr](https://matrix.to/#/#stack-of-tasks:laas.fr) +## How can I install dynamic-graph? ### Compiling and installing the package @@ -68,24 +34,21 @@ The manual compilation requires two steps: 1. configuration of the build and generation of the build files 2. compilation of the sources and installation of the package -dynamic-graph uses [CMake][] to generate build files. It is +dynamic-graph uses CMake to generate build files. It is recommended to create a separate build directory: ```sh -mkdir _build # (1) Create a build directory -cd _build # (2) Go to the newly created build directory -cmake [options] .. # (3) Generate the build files +mkdir build +cd build +cmake .. ``` -Options which can be passed to CMake are detailed in the next section. - ```sh -make # (4) Compile the package -make test # (5) Execute the package tests -make install # (6) Install the package into the prefix (see step 3) +make +make test +make install ``` - ### Options Additional options can be set on the command line through the @@ -109,13 +72,8 @@ Available options are: The test suite can be run from your build directory by running: ```sh - make test +make test ``` Please open a ticket if some tests are failing on your computer, it should not be the case. - -Credits -------- - -This package authors are credited in the [AUTHORS](AUTHORS) file.