1- dynamic-graph-python
2- ====================
1+ # dynamic-graph-python
32
43[ ![ 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 )
54[ ![ 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
1413repository, you can run ` git submodule init && git submodule update `
1514to retrieve the submodules.
1615
16+ ## Documentation
1717
18- Documentation
19- -------------
18+ [ Online] ( https://gepettoweb.laas.fr/doc/stack-of-tasks/dynamic-graph-python/master/doxygen-html/ )
2019
21- To get started with this library, please read the [ online Doxygen
22- documentation] [ doxygen-documentation ] .
2320
24- It can also be generated locally by running the ` make doc `
25- command. After the package is installed, the documentation will be
26- located in the ` $prefix/share/doc/dynamic-graph ` directoy where
27- ` $prefix ` is your installation prefix (` /usr/local ` by default).
28-
29-
30- Getting Help
31- ------------
21+ ## Getting Help
3222
3323Support is provided through:
34- * the HPP mailing-list: hpp@laas.fr
35- * the following HipChat room: http://www.hipchat.com/gh4wQrZeV
36-
37-
38- How can I install dynamic-graph?
39- --------------------------------
40-
41- ### Installing dependencies
42-
43- The matrix abstract layer depends on several packages which
44- have to be available on your machine.
45-
46- - Libraries:
47- - [ Boost] [ ] (>= 1.40)
48- Its detection is controled by the ` BOOST_ROOT ` variable, see next section
49- for more information.
50- - [ Lapack] [ ] library
51- Use the generic purpose ` CMAKE_CXX_FLAGS ` and ` CMAKE_EXE_LINKER_FLAGS `
52- to insert the flags required for the compiler to find your Lapack library
53- if it is installed in a non-standard directory.
54- - [ jrl-mal] [ ] library
55- - [ dynamic-graph] [ ] library
56- - System tools:
57- - [ CMake] [ ] (>=2.6)
58- - [ pkg-config] [ ]
59- - usual compilation tools (GCC/G++, make, etc.)
60- If you are using Ubuntu, these tools are gathered in the ` build-essential ` package.
24+ * the [ issue tracker] ( https://github.com/stack-of-tasks/dynamic-graph-python/issues )
25+ * the matrix room [ #stack-of-tasks: laas .fr] ( https://matrix.to/#/#stack-of-tasks:laas.fr )
6126
6227
28+ ## How can I install dynamic-graph?
6329
6430### Compiling and installing the package
6531
@@ -68,24 +34,21 @@ The manual compilation requires two steps:
6834 1 . configuration of the build and generation of the build files
6935 2 . compilation of the sources and installation of the package
7036
71- dynamic-graph uses [ CMake] [ ] to generate build files. It is
37+ dynamic-graph uses CMake to generate build files. It is
7238recommended to create a separate build directory:
7339
7440``` sh
75- mkdir _build # (1) Create a build directory
76- cd _build # (2) Go to the newly created build directory
77- cmake [options] .. # (3) Generate the build files
41+ mkdir build
42+ cd build
43+ cmake ..
7844```
7945
80- Options which can be passed to CMake are detailed in the next section.
81-
8246``` sh
83- make # (4) Compile the package
84- make test # (5) Execute the package tests
85- make install # (6) Install the package into the prefix (see step 3)
47+ make
48+ make test
49+ make install
8650```
8751
88-
8952### Options
9053
9154Additional options can be set on the command line through the
@@ -109,13 +72,8 @@ Available options are:
10972The test suite can be run from your build directory by running:
11073
11174``` sh
112- make test
75+ make test
11376```
11477
11578Please open a ticket if some tests are failing on your computer, it
11679should not be the case.
117-
118- Credits
119- -------
120-
121- This package authors are credited in the [ AUTHORS] ( AUTHORS ) file.
0 commit comments