diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 8edb3dd..6ef254a 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -43,6 +43,26 @@ command line to ease recurring operations:
* ``invoke test``: Run all tests and checks in one swift command.
* ``invoke``: Show available tasks.
+Releasing this project
+----------------------
+
+Ready to release a new version of **pybullet_planning**? Here's how to do it:
+
+* We use `semver `_, i.e. we bump versions as follows:
+
+ * ``patch``: bugfixes.
+ * ``minor``: backwards-compatible features added.
+ * ``major``: backwards-incompatible changes.
+
+* Update the ``CHANGELOG.rst`` with all novelty!
+* Ready? Release everything in one command:
+
+::
+
+ invoke release [patch|minor|major]
+ # with -b to bump version
+
+* Celebrate! 💃
Documentation improvements
--------------------------
diff --git a/README.rst b/README.rst
index 969c3eb..dcdc2be 100644
--- a/README.rst
+++ b/README.rst
@@ -27,7 +27,9 @@ pybullet_planning
.. Write project description
-**pybullet_planning** is a suite of utility functions to facilitate robotic planning related research on the `pybullet `_ physics simulation engine. Planning research made easy.
+**pybullet_planning** is a suite of utility functions to facilitate robotic planning related research on
+the `pybullet `_ physics simulation engine.
+Planning research made easy.
Main features
@@ -50,7 +52,8 @@ Getting Started
.. note::
On Windows, you may need to install
- `Microsoft Visual C++ 14.0 `_.
+ `Microsoft Visual C++ 14.0 `_,
+ if pybullet installation fails.
Once the installation is completed, you can verify your setup.
@@ -58,7 +61,7 @@ Start Python from the command prompt and run the following:
::
- >>> import pybullet_planning
+ >>> import pybullet_planning as pp
First Steps
@@ -69,31 +72,7 @@ First Steps
Contributing
------------
-We love contributions!
-
-Check the `Contributor's Guide <./CONTRIBUTING.rst>`_
-for more details.
-
-Releasing this project
-----------------------
-
-Ready to release a new version of **pybullet_planning**? Here's how to do it:
-
-* We use `semver `_, i.e. we bump versions as follows:
-
- * ``patch``: bugfixes.
- * ``minor``: backwards-compatible features added.
- * ``major``: backwards-incompatible changes.
-
-* Update the ``CHANGELOG.rst`` with all novelty!
-* Ready? Release everything in one command:
-
-::
-
- invoke release [patch|minor|major]
- # with -b to bump version
-
-* Celebrate! 💃
+Check the `Contributor's Guide <./CONTRIBUTING.rst>`_ for more details.
PyBullet Resources
-------------------
@@ -104,6 +83,7 @@ PyBullet Resources
* Wordpress - https://pybullet.org/wordpress/
* Examples - https://github.com/bulletphysics/bullet3/tree/master/examples/pybullet/examples
* Bindings - https://github.com/bulletphysics/bullet3/blob/master/examples/pybullet/pybullet.c
+* Predecessors - `pybullet-planning`_, `motion-planners`_.
Credits
-------------
@@ -113,6 +93,12 @@ Credits
This package was initiated and maintained by Caelan Garrett `@caelan `_
and other `contributors `_.
-This repo is a stable and documented fork of Caelan's `pybullet-planning `_
-(previously called `ss-pybullet`) and `motion-planners `_.
+History
+-------------
+
+This repo is a stable and documented fork of Caelan's `pybullet-planning`_
+(previously called `ss-pybullet`) and `motion-planners`_.
New features will continue to be introduced first through these separate repos, and integrated into the current package later.
+
+.. _pybullet-planning: https://github.com/caelan/pybullet-planning
+.. _motion-planners: https://github.com/caelan/motion-planners
diff --git a/tests/planner_2D_utils.py b/tests/planner_2D_utils.py
index b346a64..4c8c655 100644
--- a/tests/planner_2D_utils.py
+++ b/tests/planner_2D_utils.py
@@ -1,3 +1,5 @@
+# This file attemps to port Caelan's tkinker example for motion-planners to pybullet:
+# https://github.com/caelan/motion-planners/tree/master/motion_planners/tkinter
import numpy as np
import math
@@ -163,8 +165,9 @@ def add_roadmap(roadmap, **kwargs):
pp.add_line(np.hstack([line[0], [DRAW_Z]]), np.hstack([line[1], [DRAW_Z]]), **kwargs)
def draw_roadmap(roadmap, obstacles, regions):
- draw_environment(obstacles, regions)
- add_roadmap(roadmap)
+ with pp.LockRenderer():
+ draw_environment(obstacles, regions)
+ add_roadmap(roadmap)
def add_points(points, **kwargs):
for sample in points: