Commit ed550e2d authored by Guilhem Saurel's avatar Guilhem Saurel
Browse files

[README] clean obsolete stuff, fix #66

parent 81538443
dynamic-graph-python # dynamic-graph-python
====================
[![Building Status](https://travis-ci.org/stack-of-tasks/dynamic-graph-python.svg?branch=master)](https://travis-ci.org/stack-of-tasks/dynamic-graph-python) [![Building Status](https://travis-ci.org/stack-of-tasks/dynamic-graph-python.svg?branch=master)](https://travis-ci.org/stack-of-tasks/dynamic-graph-python)
[![Pipeline status](https://gitlab.laas.fr/stack-of-tasks/dynamic-graph-python/badges/master/pipeline.svg)](https://gitlab.laas.fr/stack-of-tasks/dynamic-graph-python/commits/master) [![Pipeline status](https://gitlab.laas.fr/stack-of-tasks/dynamic-graph-python/badges/master/pipeline.svg)](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 ...@@ -14,52 +13,19 @@ submodules][git-submodules]. Please clone this repository using the
repository, you can run `git submodule init && git submodule update` repository, you can run `git submodule init && git submodule update`
to retrieve the submodules. 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` ## Getting Help
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
------------
Support is provided through: Support is provided through:
* the HPP mailing-list: hpp@laas.fr * the [issue tracker](https://github.com/stack-of-tasks/dynamic-graph-python/issues)
* the following HipChat room: http://www.hipchat.com/gh4wQrZeV * the matrix room [#stack-of-tasks:laas.fr](https://matrix.to/#/#stack-of-tasks:laas.fr)
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.
## How can I install dynamic-graph?
### Compiling and installing the package ### Compiling and installing the package
...@@ -68,24 +34,21 @@ The manual compilation requires two steps: ...@@ -68,24 +34,21 @@ The manual compilation requires two steps:
1. configuration of the build and generation of the build files 1. configuration of the build and generation of the build files
2. compilation of the sources and installation of the package 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: recommended to create a separate build directory:
```sh ```sh
mkdir _build # (1) Create a build directory mkdir build
cd _build # (2) Go to the newly created build directory cd build
cmake [options] .. # (3) Generate the build files cmake ..
``` ```
Options which can be passed to CMake are detailed in the next section.
```sh ```sh
make # (4) Compile the package make
make test # (5) Execute the package tests make test
make install # (6) Install the package into the prefix (see step 3) make install
``` ```
### Options ### Options
Additional options can be set on the command line through the Additional options can be set on the command line through the
...@@ -109,13 +72,8 @@ Available options are: ...@@ -109,13 +72,8 @@ Available options are:
The test suite can be run from your build directory by running: The test suite can be run from your build directory by running:
```sh ```sh
make test make test
``` ```
Please open a ticket if some tests are failing on your computer, it Please open a ticket if some tests are failing on your computer, it
should not be the case. should not be the case.
Credits
-------
This package authors are credited in the [AUTHORS](AUTHORS) file.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment