Skip to content

updated dev docs, fixes #6 #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
guyfleeman wants to merge 1 commit into
base: master
Choose a base branch
from
Open

updated dev docs, fixes #6 #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,23 @@ This simulator is built using Python 3.5, so you'll need to install that on your

We haven't been able to test with previous versions yet, but anything 3.x should work.

## Users
To install, navigate the directory in which you cloned the simulator. Then, run
```
sudo pip3 install .
```
This instruction will install the necessary packages and the simulator on your system. Don't forget the '.' on the end! Once this installation is complete, you should be able to run the examples in the 'examples' folder.

If you want to edit the simulator files, you will need to follow the directions in the Developers section.

## Developers
Anyone who wants to modify the simulator code or contribute back to the repository will need the installed robotarium module to be editable. To install the module in editable mode, run
```
sudo pip3 install -e .
```

If you have an existing installation of the rps module, this will overwrite it in the cache by symlinking those cached files to the ones in the cloned repositoy.

# Dependencies
The dependencies are:
* scipy
Expand Down