8000 Update README.md · navrobot/robotics-toolbox-python@c72ce54 · GitHub
[go: up one dir, main page]

Skip to content

Commit c72ce54

Browse files
authored
Update README.md
1 parent 44eabe6 commit c72ce54

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,32 @@
55
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/petercorke/robotics-toolbox-python/graphs/commit-activity)
66
[![GitHub stars](https://img.shields.io/github/stars/petercorke/robotics-toolbox-python.svg?style=social&label=Star)](https://GitHub.com/petercorke/spatialmath-python/stargazers/)
77

8-
# A Robotics Toolbox for Python
8+
# Robotics Toolbox for Python
9+
10+
## Work in progress
11+
12+
This is a Python implementation of the [Robotics Toolbox for MATLAB<sup>&reg;</sup>](https://github.com/petercorke/robotics-toolbox-matlab).
13+
14+
* GitHub repository [https://github.com/petercorke/robotics-toolbox-python](https://github.com/petercorke/robotics-toolbox-python)
15+
* Documentation [https://petercorke.github.io/robotics-toolbox-python](https://petercorke.github.io/robotics-toolbox-python)
16+
* Dependencies: `spatialmath-python`, `numpy`
17+
18+
# Getting going
19+
20+
## Using pip
21+
22+
Install a snapshot from PyPI
23+
24+
```
25+
% # Coming soon
26+
```
27+
28+
## From GitHub
29+
30+
Install the current code base from GitHub and pip install a link to that cloned copy
31+
32+
```
33+
% git clone https://github.com/petercorke/robotics-toolbox-python.git
34+
% cd robotics-toolbox-python
35+
% pip install -e .
936
10-
This is an attempt at creating an open Python version of the venerable Robotics Toolbox for MATLAB. Significant work in progress.

0 commit comments

Comments
 (0)
0