Skip to content

Commit 8bc0464

Browse files
authored
Update README.md
update readme
1 parent 881f857 commit 8bc0464

File tree

1 file changed

+19
-22
lines changed

1 file changed

+19
-22
lines changed

README.md

Lines changed: 19 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## astar-algorithm
22

3-
[![Build Status](https://travis-ci.org/justinhj/astar-algorithm-cpp.svg?branch=master)](https://travis-ci.org/justinhj/astar-algorithm-cpp) [![Join the chat at https://gitter.im/astar-algorithm-cpp/community](https://badges.gitter.im/astar-algorithm-cpp/community.svg)](https://gitter.im/astar-algorithm-cpp/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
3+
![Build Status](https://github.com/justinhj/astar-algorithm-cpp/workflows/C/C++ CI/badge.svg)
44

55
### Summary
66

@@ -11,7 +11,7 @@ https://www.heyes-jones.com/astar.php
1111

1212
The A* algorithm was described in the paper https://ieeexplore.ieee.org/document/4082128 by Hart, Nillson and Raphael.
1313

14-
Sadly Nils Nillson passed away in 2019, his work is much appreciated.
14+
This repository is dedicated to the memory of Nils Nillson who passed away in 2019.
1515

1616
Contributions:
1717

@@ -20,22 +20,27 @@ Contributions:
2020
* @Rasoul for submitting the path to Bucharest. Sample from Artificial Intelligence: A Modern Approach
2121
* @sergiosota For fixing a number of issues related to memory management
2222

23+
### Release notes
24+
25+
[v1.0](https://github.com/justinhj/astar-algorithm-cpp/releases/tag/v1.0)
26+
Initial release once API stable.
27+
2328
### License
2429

2530
This software is released under the MIT License, see license.txt
2631

2732
### Commercial Use
2833

29-
This software has been used in AAA video games and is well tested in the wild. Please let me know if you use this code in your games, studies or hobby projects.
34+
This software has been used in a number of AAA video games, which is an area of software that relies on efficiency and reliability. In addition it has been used in a number of academic and personal projects that require efficient search. Please
3035

31-
If you feel the need to pay money for this code, it is not required by the license, but you could contribute to Unicef, a charity which helps children worldwide, http://www.unicef.org/ that would be awesome.
36+
Commercial users of the code are encouraged to make a donation to http://www.unicef.org/ if they find this project useful.
3237

3338
### Projects using this code
3439

3540
If you wish to be added to the list of known products/educational projects using the code please contact me.
3641

3742
* Gun, Activision
38-
* Company of Heroes and Company of Heroes Online, Relic Entertainment
43+
* Company of Heroes (various versions), Relic Entertainment
3944
* Angel Engine, a game prototyping engine http://code.google.com/p/angel-engine/
4045
* War of Sonria, a strategy war game on PSP and Playstation 3 by Playground Squad
4146
* Lighthouses AI contest https://github.com/marcan/lighthouses_aicontest
@@ -74,24 +79,16 @@ For path finder
7479
pathfind has no arguments. You can edit the simple map in pathfind.cpp and the start
7580
and goal co-ordinates to experiement with the pathfinder.
7681

77-
Fixed size allocator notes: As mentioned briefly in the tutorial you can enable and disable the
78-
faster memory allocation. This allocates a fixed size block of memory, so you have to specify this size
79-
with the astar constructor. You need to enlarge it if you hit an out of memory assert during the
80-
search.
81-
82-
Compilation notes:
83-
84-
Microsoft Visual C++ : Confirmed working with version 8.0.50727 with some deprecation warnings
85-
I'm going to leave the deprecation warnings in so that it still works cleanly with GCC.
86-
TODO Make a non-deprecated compliant version using compiler checking
87-
88-
Compiled with:
82+
#### Fixed size allocator
8983

90-
Apple clang version 12.0.0 (clang-1200.0.32.28)
91-
Target: x86_64-apple-darwin19.6.0
84+
FSA is just a simple memory pool that uses a doubly linked list of available nodes in an array. This is
85+
a very efficient way to manage memory. It has no automatic resizing, so you must account for the fact it
86+
will use a fixed block of memory per instance and will report an error when memory is exhausted.
9287

93-
Please let me know if it does not compile on a particular platform by opening an issue.
88+
As mentioned briefly in the tutorial you can enable and disable the faster memory allocation. This allocates
89+
a fixed size block of memory, so you have to specify this size with the astar constructor. You need to enlarge
90+
it if you hit an out of memory assert during the search.
9491

95-
Cheers!
92+
Compatibility notes:
9693

97-
Justin
94+
This version of the code requires any standards compliant C++98/03

0 commit comments

Comments
 (0)