Skip to content

Commit 367cae8

Browse files
authored
Merge branch 'master' into patch-1
2 parents 64ed1e3 + 1646017 commit 367cae8

File tree

1 file changed

+22
-7
lines changed

1 file changed

+22
-7
lines changed

README.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,28 @@
11
# Python Robotics
2-
A toolbox for robot dynamic simulation, analysis, control and planning
32

3+
A toolbox for robot dynamic simulation, analysis, control and planning.
44

5+
## Installation ##
56

6-
## Installing
7+
Required libraries:
78

8-
To install the package, use:
9-
```bash
10-
pip install git+https://github.com/SherbyRobotics/pyro
11-
```
9+
* numpy
10+
* scipy
11+
* matplotlib
12+
* pytest (only to run tests)
1213

13-
It will install the files from the project (not only one `__init__.py`). It will also check to install the required dependencies.
14+
Run the following command to install the pyro library to your python
15+
environment:
16+
17+
`python setup.py install`
18+
19+
## Development ##
20+
21+
Use `python setup.py develop` to install in develop mode, which will
22+
create a link (.egg-link file) to this code. The `pyro` module
23+
will therefore be automatically updated as you edit the code in this
24+
repository.
25+
26+
Run tests: `pytest -ra ./tests` (from repository root)
27+
28+
Run all examples: `pytest -ra ./examples` (from repository root)

0 commit comments

Comments
 (0)