Skip to content

Commit a2d5337

Browse files
author
Bryce Neal
committed
Updated README.md
1 parent 7d3b04d commit a2d5337

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![Launch Example](http://prettymuchbryce.com/easystarjs/easystar.jpg)](http://prettymuchbryce.com/easystarjs/example/example.html)
44

5-
A* is an algorithm for finding the shortest path between two points. It is very useful in game development. Any tile-based game that requires this kind of movement will probably utilize some form of A*. Tower Defense games, City Building games, Rogue-Likes, the list goes on.
5+
A* is an algorithm for finding the shortest path between two points. It is very useful in game development. Any tile-based game that requires this kind of movement will probably utilize some form of A*. Tower defense games, city-building games, roguelikes, the list goes on.
66

77
Thus EasyStar.js is a simple A* API written in Javascript.
88

@@ -95,6 +95,28 @@ The only thing left to do is to calculate the path.
9595

9696
EasyStar.js is licensed under the MIT license, which means you can use it for almost anything, even commercial use.
9797

98+
## Running the example locally
99+
100+
In order to run the example do the follow.
101+
102+
git clone https://github.com/prettymuchbryce/easystarjs.git
103+
104+
cd easystarjs/example
105+
106+
npm install
107+
108+
node app.js
109+
110+
Then open your browser to 127.0.0.1:3000
111+
112+
## Roadmap
113+
114+
* Unit tests with Mocha and Chai
115+
* More friendly API
116+
* Tiles with varying costs
117+
* Optional diagonals
118+
* Node support ?
119+
98120
## Support
99121

100-
If you have any questions, comments, or suggestions you can email me at [email protected]
122+
If you have any questions, comments, or suggestions please feel free to open an issue.

0 commit comments

Comments
 (0)