Skip to content

Commit

Permalink
Update README to show Todos!
Browse files Browse the repository at this point in the history
  • Loading branch information
Gerd Gruenert committed Jan 30, 2018
1 parent 2049099 commit 7c73dff
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,3 +101,15 @@ print (tra.y)
Or more complete: `plot_path.py`

![alt text](example_images/plot_path.png?raw=true "paths")


TODOs
=====

* improve documentation
* Add support for the case of: om12_dist <= 2 * self.params.outer_rad.
I.e., when the centers of the two circles are very close together!
(PathType.lrl, PathType.rlr)
* Add unit tests
* add setup.py to install via pip

0 comments on commit 7c73dff

Please sign in to comment.