Fix the version number and add more in README
This commit is contained in:
parent
165abd83dc
commit
1b78cb541a
|
|
@ -3,3 +3,17 @@
|
||||||
This package is the code library for _Modern Robotics: Mechanics, Planning,
|
This package is the code library for _Modern Robotics: Mechanics, Planning,
|
||||||
and Control_. For more details please see the library introduction pdf file
|
and Control_. For more details please see the library introduction pdf file
|
||||||
or the [website](http://modernrobotics.org/).
|
or the [website](http://modernrobotics.org/).
|
||||||
|
|
||||||
|
To use the package, you can either
|
||||||
|
|
||||||
|
* Run `python setup.py build` and `python setup.py install` in the package directory
|
||||||
|
|
||||||
|
* Run `pip install modern_robotics` to use pip to install
|
||||||
|
|
||||||
|
* Copy `modern_robotics` directory into working directory
|
||||||
|
|
||||||
|
To import the package, we recommend using
|
||||||
|
|
||||||
|
```
|
||||||
|
import modern_robotics as mr
|
||||||
|
```
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,10 @@
|
||||||
from setuptools import setup
|
from setuptools import setup
|
||||||
|
|
||||||
|
exec(open('modern_robotics/__version__.py').read())
|
||||||
|
|
||||||
setup(
|
setup(
|
||||||
name = "modern_robotics",
|
name = "modern_robotics",
|
||||||
version = "__version__",
|
version = __version__,
|
||||||
author = "Huan Weng, Mikhail Todes, Jarvis Schultz, Bill Hunt",
|
author = "Huan Weng, Mikhail Todes, Jarvis Schultz, Bill Hunt",
|
||||||
author_email = "huanweng@u.northwestern.edu",
|
author_email = "huanweng@u.northwestern.edu",
|
||||||
description = ("Modern Robotics: Mechanics, Planning, and Control: Code Library"),
|
description = ("Modern Robotics: Mechanics, Planning, and Control: Code Library"),
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue