Skip to content

Commit fb34d74

Browse files
vibloviblo
committed
Fix MakeDocs script, and slightly update docs
1 parent 96d324e commit fb34d74

File tree

3 files changed

+55
-38
lines changed

3 files changed

+55
-38
lines changed

‎doc-src/MakeDocs.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ def pop_open_div(name)
3737

3838
def pop_open_example(name)
3939
divid = "Pop Open #{name} Example"
40-
return %{<div><a class="HideShow" href="javascript:;" onmousedown="toggleExample('#{divid}', 'examples/#{URI.escape(name)}.html');">Hide/Show #{name} Example</a><div id="#{divid}" style="display:none"></div></div>}
40+
return %{<div><a class="HideShow" href="javascript:;" onmousedown="toggleExample('#{divid}', 'examples/#{CGI.escape(name)}.html');">Hide/Show #{name} Example</a><div id="#{divid}" style="display:none"></div></div>}
4141
end
4242

4343
$node_path = [Node::Root]

‎doc-src/chipmunk-docs.textile‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,19 @@
22

33
<%= pop_open_div("Outline") %><%%= Node::Root.outline %></div></div>
44

5-
<%= h 1, "Chipmunk2D 7.0.3", "Intro" %>
5+
<%= h 1, "Munk2D 8.0.0", "Title" %>
6+
7+
<%= h 2, "Fork Info - Start here", "ForkInfo" %>
8+
9+
"Munk2D":https://github.com/viblo/Munk2D is a friendly fork of the original "Chipmunk2D":https://github.com/slembcke/Chipmunk2D 2D physics library.
10+
11+
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.
12+
13+
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.
14+
15+
The rest of the documentation is minimally edited from the original Chipmunk2D.
16+
17+
<%= h 2, "Intro", "Intro" %>
618

719
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!
820

‎doc-src/doxygen_main‎

Lines changed: 41 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,41 @@
1-
/**
2-
@mainpage Chipmunk2D and Chipmunk2D Pro API reference.
3-
4-
<h1>What is Chipmunk2D?</h1>
5-
6-
First of all, <a href="http://chipmunk2d.net">Chipmunk2D</a> is a 2D rigid body physics library distributed under the MIT license.
7-
It is intended to be fast, portable, numerically stable, and easy to use.
8-
For this reason it's been used in hundreds of games across every recent system you can name.
9-
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!
10-
11-
Chipmunk2D Pro builds on what we've made with C Chipmunk2D and extended it with more features, platform specific performance tuning, and new features.
12-
Currently we offer a Objective-C binding, ARM NEON optimizations for mobile CPUs, and a very high performance and flexible automatic geometry library.
13-
14-
Objective-Chipmunk for iPhone/Mac provides extended APIs and a first rate Objective-C wrapper with support for
15-
properties, blocks and ARC (automatic reference counting) to make Chipmunk2D coding more efficient with your time on Apple platforms.
16-
17-
The ARM optimizations use the NEON SIMD coprocessor found in any smartphone using an ARM Cortex A* CPU
18-
including all iOS hardware since the 3GS and many Android phones.
19-
20-
The auto geometry library can generate geometry from bitmap images or procedural data.
21-
You can use it for generating convex hull shapes from sprites, or create an entire level's collision shapes from a background image.
22-
It can also be easily set up to be used for high-performance deformable terrain or infinite procedural terrain.
23-
24-
If you'd like to hear more about Chipmunk2D Pro or download a trial library check out the <a href="http://chipmunk-physics.net/chipmunkPro.php">Chipmunk2D Pro page</a>.
25-
26-
<h1>Where do I start?</h1>
27-
28-
You might want to start by looking at some <a href="http://chipmunk-physics.net/downloads.php">sample code</a>.
29-
From there, you probably want to skim over the latest
30-
<a href="http://files.slembcke.net/chipmunk/release/ChipmunkLatest-Docs/">documentation</a>.
31-
While geared towards C developers, it introduces all the important building blocks.
32-
The Objective-C API simply takes things to the next logical step.
33-
34-
<h1>Note:</h1>
35-
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.
36-
*/
1+
/** @mainpage Chipmunk2D and Chipmunk2D Pro API reference.
2+
3+
<h2>What is Chipmunk2D?</h2>
4+
5+
First of all, <a href="http://chipmunk2d.net">Chipmunk2D</a> is a 2D rigid body
6+
physics library distributed under the MIT license. It is intended to be fast,
7+
portable, numerically stable, and easy to use. For this reason it's been used in
8+
hundreds of games across every recent system you can name. I've put thousands of
9+
hours of work over many years to make Chipmunk2D what it is today. I hope you
10+
enjoy working with it! Chipmunk2D Pro builds on what we've made with C
11+
Chipmunk2D and extended it with more features, platform specific performance
12+
tuning, and new features. Currently we offer a Objective-C binding, ARM NEON
13+
optimizations for mobile CPUs, and a very high performance and flexible
14+
automatic geometry library. Objective-Chipmunk for iPhone/Mac provides extended
15+
APIs and a first rate Objective-C wrapper with support for properties, blocks
16+
and ARC (automatic reference counting) to make Chipmunk2D coding more efficient
17+
with your time on Apple platforms. The ARM optimizations use the NEON SIMD
18+
coprocessor found in any smartphone using an ARM Cortex A* CPU including all iOS
19+
hardware since the 3GS and many Android phones. The auto geometry library can
20+
generate geometry from bitmap images or procedural data. You can use it for
21+
generating convex hull shapes from sprites, or create an entire level's
22+
collision shapes from a background image. It can also be easily set up to be
23+
used for high-performance deformable terrain or infinite procedural terrain. If
24+
you'd like to hear more about Chipmunk2D Pro or download a trial library check
25+
out the
26+
<a href="http://chipmunk-physics.net/chipmunkPro.php">Chipmunk2D Pro page</a>.
27+
28+
<h2>Where do I start?</h2>
29+
30+
You might want to start by looking at some
31+
<a href="http://chipmunk-physics.net/downloads.php">sample code</a>. From there,
32+
you probably want to skim over the latest
33+
<a href="http://files.slembcke.net/chipmunk/release/ChipmunkLatest-Docs/"
34+
>documentation</a
35+
>. While geared towards C developers, it introduces all the important building
36+
blocks. The Objective-C API simply takes things to the next logical step.
37+
38+
<h2>Note:</h2>
39+
These Doxygen docs cover both the C Chipmunk2D API as well as
40+
Objective-Chipmunk. The Objective-Chipmunk classes (Chipmunk*) are not available
41+
except with Chipmunk2D Pro. */

0 commit comments

Comments
 (0)