diff --git a/doc-src/MakeDocs.rb b/doc-src/MakeDocs.rb index be467b89..d46eb095 100644 --- a/doc-src/MakeDocs.rb +++ b/doc-src/MakeDocs.rb @@ -37,7 +37,7 @@ def pop_open_div(name) def pop_open_example(name) divid = "Pop Open #{name} Example" - return %{
Hide/Show #{name} Example
} + return %{
Hide/Show #{name} Example
} end $node_path = [Node::Root] diff --git a/doc-src/chipmunk-docs.textile b/doc-src/chipmunk-docs.textile index 8c0109a1..f6ca45ab 100644 --- a/doc-src/chipmunk-docs.textile +++ b/doc-src/chipmunk-docs.textile @@ -2,7 +2,19 @@ <%= pop_open_div("Outline") %><%%= Node::Root.outline %> -<%= h 1, "Chipmunk2D 7.0.3", "Intro" %> +<%= h 1, "Munk2D 8.0.0", "Title" %> + +<%= h 2, "Fork Info - Start here", "ForkInfo" %> + +"Munk2D":https://github.com/viblo/Munk2D is a friendly fork of the original "Chipmunk2D":https://github.com/slembcke/Chipmunk2D 2D physics library. + +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 (Viblo/author of Pymunk) consider to make it more formal was the discussion "here":https://github.com/slembcke/Chipmunk2D/issues/237 with Slembcke, the creator of Chipmunk2D. + +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, I do think many of these changes are useful also to users outside of Pymunk, and you are of course free to use the fork for other projects / languages as well. + +The rest of the documentation is minimally edited from the original Chipmunk2D. + +<%= h 2, "Intro", "Intro" %> Chipmunk2D is a 2D rigid body physics library distributed under the MIT license. It is blazingly fast, portable, numerically stable, and easy to use. For this reason it has been used in hundreds of games across just about every system you can name. This includes top quality titles such as Night Sky for the Wii and many #1 sellers on the iPhone App Store! I've put thousands of hours of work over many years to make Chipmunk2D what it is today. If you find Chipmunk2D has saved you a lot of time, please consider "donating":https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=6666552. You'll make an indie game developer very happy! diff --git a/doc-src/doxygen_main b/doc-src/doxygen_main index 7771fca3..4535aaaf 100644 --- a/doc-src/doxygen_main +++ b/doc-src/doxygen_main @@ -1,36 +1,41 @@ -/** - @mainpage Chipmunk2D and Chipmunk2D Pro API reference. - -

What is Chipmunk2D?

- - First of all, Chipmunk2D is a 2D rigid body physics library distributed under the MIT license. - It is intended to be fast, portable, numerically stable, and easy to use. - For this reason it's been used in hundreds of games across every recent system you can name. - I've put thousands of hours of work over many years to make Chipmunk2D what it is today. I hope you enjoy working with it! - - Chipmunk2D Pro builds on what we've made with C Chipmunk2D and extended it with more features, platform specific performance tuning, and new features. - Currently we offer a Objective-C binding, ARM NEON optimizations for mobile CPUs, and a very high performance and flexible automatic geometry library. - - Objective-Chipmunk for iPhone/Mac provides extended APIs and a first rate Objective-C wrapper with support for - properties, blocks and ARC (automatic reference counting) to make Chipmunk2D coding more efficient with your time on Apple platforms. - - The ARM optimizations use the NEON SIMD coprocessor found in any smartphone using an ARM Cortex A* CPU - including all iOS hardware since the 3GS and many Android phones. - - The auto geometry library can generate geometry from bitmap images or procedural data. - You can use it for generating convex hull shapes from sprites, or create an entire level's collision shapes from a background image. - It can also be easily set up to be used for high-performance deformable terrain or infinite procedural terrain. - - If you'd like to hear more about Chipmunk2D Pro or download a trial library check out the Chipmunk2D Pro page. - -

Where do I start?

- - You might want to start by looking at some sample code. - From there, you probably want to skim over the latest - documentation. - While geared towards C developers, it introduces all the important building blocks. - The Objective-C API simply takes things to the next logical step. - -

Note:

- These Doxygen docs cover both the C Chipmunk2D API as well as Objective-Chipmunk. The Objective-Chipmunk classes (Chipmunk*) are not available except with Chipmunk2D Pro. -*/ +/** @mainpage Chipmunk2D and Chipmunk2D Pro API reference. + +

What is Chipmunk2D?

+ +First of all, Chipmunk2D is a 2D rigid body +physics library distributed under the MIT license. It is intended to be fast, +portable, numerically stable, and easy to use. For this reason it's been used in +hundreds of games across every recent system you can name. I've put thousands of +hours of work over many years to make Chipmunk2D what it is today. I hope you +enjoy working with it! Chipmunk2D Pro builds on what we've made with C +Chipmunk2D and extended it with more features, platform specific performance +tuning, and new features. Currently we offer a Objective-C binding, ARM NEON +optimizations for mobile CPUs, and a very high performance and flexible +automatic geometry library. Objective-Chipmunk for iPhone/Mac provides extended +APIs and a first rate Objective-C wrapper with support for properties, blocks +and ARC (automatic reference counting) to make Chipmunk2D coding more efficient +with your time on Apple platforms. The ARM optimizations use the NEON SIMD +coprocessor found in any smartphone using an ARM Cortex A* CPU including all iOS +hardware since the 3GS and many Android phones. The auto geometry library can +generate geometry from bitmap images or procedural data. You can use it for +generating convex hull shapes from sprites, or create an entire level's +collision shapes from a background image. It can also be easily set up to be +used for high-performance deformable terrain or infinite procedural terrain. If +you'd like to hear more about Chipmunk2D Pro or download a trial library check +out the +Chipmunk2D Pro page. + +

Where do I start?

+ +You might want to start by looking at some +sample code. From there, +you probably want to skim over the latest +documentation. While geared towards C developers, it introduces all the important building +blocks. The Objective-C API simply takes things to the next logical step. + +

Note:

+These Doxygen docs cover both the C Chipmunk2D API as well as +Objective-Chipmunk. The Objective-Chipmunk classes (Chipmunk*) are not available +except with Chipmunk2D Pro. */