Skip to content

Commit 92fcdc2

Browse files
committed
docs: install from pypi and add badge
1 parent 4900492 commit 92fcdc2

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# plainmp [![build & test](https://github.com/HiroIshida/plainmp/actions/workflows/build_and_test.yaml/badge.svg)](https://github.com/HiroIshida/plainmp/actions/workflows/build_and_test.yaml) [![format](https://github.com/HiroIshida/plainmp/actions/workflows/check_format.yaml/badge.svg)](https://github.com/HiroIshida/plainmp/actions/workflows/check_format.yaml) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14271046.svg)](https://doi.org/10.5281/zenodo.14271046)
1+
# plainmp [![build & test](https://github.com/HiroIshida/plainmp/actions/workflows/build_and_test.yaml/badge.svg)](https://github.com/HiroIshida/plainmp/actions/workflows/build_and_test.yaml) [![format](https://github.com/HiroIshida/plainmp/actions/workflows/check_format.yaml/badge.svg)](https://github.com/HiroIshida/plainmp/actions/workflows/check_format.yaml) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14271046.svg)](https://doi.org/10.5281/zenodo.14271046) [![PyPI - Version](https://img.shields.io/pypi/v/plainmp)](https://pypi.org/project/plainmp)
22

33
![result](https://github.com/user-attachments/assets/fde49de1-f583-4f1d-933b-5853cea6bccc)
44

@@ -49,11 +49,9 @@ python3 example/bench/fetch_plan.py # fetch table
4949

5050
## installation and usage
5151
```bash
52-
sudo apt-get install libspatialindex-dev freeglut3-dev libsuitesparse-dev libblas-dev liblapack-dev # for scikit-robot
53-
sudo apt install libeigen3-dev libboost-all-dev libompl-dev # plainmp dependencies
52+
sudo apt install libeigen3-dev libboost-all-dev libompl-dev libspatialindex-dev freeglut3-dev libsuitesparse-dev libblas-dev liblapack-dev
5453
pip install scikit-build
55-
git submodule update --init
56-
pip install -e . -v
54+
pip install plainmp # or build from source after git submodules update --init
5755
```
5856
Then try examples in [example directory](./example) with `--visualize` option. Note that you may need to install the following for visualization:
5957
```bash

0 commit comments

Comments
 (0)