From 1b78cb541afe064c73b908501e577eb8b89be74b Mon Sep 17 00:00:00 2001 From: HuanWeng Date: Sun, 12 Aug 2018 22:46:28 -0500 Subject: [PATCH] Fix the version number and add more in README --- packages/Python/README.md | 14 ++++++++++++++ packages/Python/setup.py | 4 +++- 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/packages/Python/README.md b/packages/Python/README.md index 150fd4e..6406f91 100644 --- a/packages/Python/README.md +++ b/packages/Python/README.md @@ -3,3 +3,17 @@ This package is the code library for _Modern Robotics: Mechanics, Planning, and Control_. For more details please see the library introduction pdf file 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 +``` diff --git a/packages/Python/setup.py b/packages/Python/setup.py index 5411753..52b4ba4 100644 --- a/packages/Python/setup.py +++ b/packages/Python/setup.py @@ -1,8 +1,10 @@ from setuptools import setup +exec(open('modern_robotics/__version__.py').read()) + setup( name = "modern_robotics", - version = "__version__", + version = __version__, author = "Huan Weng, Mikhail Todes, Jarvis Schultz, Bill Hunt", author_email = "huanweng@u.northwestern.edu", description = ("Modern Robotics: Mechanics, Planning, and Control: Code Library"),