diff --git a/README.md b/README.md index 3004af1d..a7e8101f 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,28 @@ # Python Robotics -A toolbox for robot dynamic simulation, analysis, control and planning +A toolbox for robot dynamic simulation, analysis, control and planning. +## Installation ## -## Installing +Required libraries: -To install the package, use: -```bash -pip install git+https://github.com/SherbyRobotics/pyro -``` +* numpy +* scipy +* matplotlib +* pytest (only to run tests) -It will install the files from the project (not only one `__init__.py`). It will also check to install the required dependencies. +Run the following command to install the pyro library to your python +environment: + +`python setup.py install` + +## Development ## + +Use `python setup.py develop` to install in develop mode, which will +create a link (.egg-link file) to this code. The `pyro` module +will therefore be automatically updated as you edit the code in this +repository. + +Run tests: `pytest -ra ./tests` (from repository root) + +Run all examples: `pytest -ra ./examples` (from repository root)