From 8d837e793130ff4581f481f9379ae0455e10ddab Mon Sep 17 00:00:00 2001 From: Brian Delhaisse Date: Sat, 16 Mar 2019 03:07:17 +0100 Subject: [PATCH] update README --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index a3c42e8..ac21a29 100644 --- a/README.md +++ b/README.md @@ -6,3 +6,29 @@ This framework revolves mainly around 7 axes: simulators, worlds, robots, interf ## Requirements The framework has been tested with Python 2.7 and Ubuntu 16.04. + +## Installation + +1. First download the `pip` Python package manager and create a virtual environment for Python 2.7 as described in the following link: https://packaging.python.org/guides/installing-using-pip-and-virtualenv/ +On Ubuntu, in the terminal, you can type: +```bash +sudo apt install python-pip +sudo pip install virtualenv +``` + +2. clone this repository and install the requirements and the setup.py +```bash +pip install -r requirements.txt +pip install -e . +``` + +## Citation + +``` +@misc{delhaisse2019pyrobolearn, + author = {Delhaisse, Brian and Rozo, Leonel, and Caldwell, Darwin}, + title = {PyRoboLearn: A Python Framework for Robot Learning Practitioners}, + howpublished = {\url{https://github.com/robotlearn/pyrobolearn}}, + year=2019, +} +```