From 0b010d637629f1caa76762ce1c470bdf54ef7fc6 Mon Sep 17 00:00:00 2001 From: Matthew Deyo Date: Thu, 29 Mar 2018 16:25:58 -0400 Subject: [PATCH] Update README.md --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 86f60be..3fae2cf 100644 --- a/README.md +++ b/README.md @@ -1 +1,14 @@ # d-star-lite + +This poject is based on the original [D* Lite paper](http://idm-lab.org/bib/abstracts/papers/aaai02b.pdf) by Sven Koenig and Maxim Likhachev. + +The D* Lite algorithm was written to be a "novel fast replanning method for robot navigation in unknown terrain". It searches "from the goal vertex towards the current vertex of the robot, uses heuristics to focus the search" and efficiently uses the priortity queue to minimize reordering. + +### Use of the project +Currently written for Python 3 and the biggest requirement is having Pygame. Instructions for installing pygame can be found at [https://www.pygame.org/wiki/GettingStarted](https://www.pygame.org/wiki/GettingStarted). + +Run the example demo with ```python3 main.py``` (or ```python main.py``` if you have Python 3 installed as such on your system or in your environment). + +More notes to come on how the code is organized... + +Feel free to add more specific questions about the project in comments on issue #1, so that I can add better documentation.