Skip to content

Commit 21688d0

Browse files
committed
Update readme to clarify the fork situation
1 parent 5cda934 commit 21688d0

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.textile

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,24 @@
11
!http://files.slembcke.net/chipmunk/logo/logo1_med.png!
22

3+
h2. FORK INFO - START HERE
4+
5+
This is a fork of the original "Chipmunk2D":https://github.com/slembcke/Chipmunk2D
6+
7+
The main purpose of this fork is to be a compainion for the Python 2D physics library "Pymunk":https://www.pymunk.org which is built on Chipmunk2D. Given the slow pace of development of Chipmunk2D, and some unique requirements and oppurtunitites of Pymunk this is something that have grown over a long time. What really made me consider to make it more formal was the discussion "here":https://github.com/slembcke/Chipmunk2D/issues/237 with slembcke, the creator of Chipmunk2D.
8+
9+
I do not forsee that I have the time, motivation or skills to really revive Chipmunk2D. However, I hope to incorporate minor new features, and a bunch of fixes. Any changes are driven by what make sense from the Pymunk use case. However, you are of course free to use the fork for other projects / languages as well.
10+
11+
At the moment I dont have any formal release of this fork, but I plan to make some kind of rename and a release if/when enough changes are accumulated.
12+
13+
h3. Differeces:
14+
15+
* This fork will have ABI breaking changes. For Pymunk it does not matter, a Pymunk verison is always compiled against a specific Chipmunk2D version.
16+
* This fork might have API breaking changes. Since Pymunk wraps Chipmunk2D in a Python friendly API, end users of Pymunk wont be affected.
17+
* Some additional minor features, useful from Pymunk
18+
* Fixes to various issues, affecting Pymunk
19+
20+
---
21+
322
h2. NEW IN CHIPMUNK 7
423

524
Chipmunk 7 is complete and now includes the ARM NEON optimizations, the autogeometry code, and the mulithreaded solver.

0 commit comments

Comments
 (0)