doc/index.html in motion-game-1.1 vs doc/index.html in motion-game-1.1.1

- old
+ new

@@ -61,54 +61,101 @@ <iframe id="search_frame"></iframe> <div id="content"><div id='filecontents'><h1>motion-game</h1> -<p>motion-game is a cross-platform mobile game engine for RubyMotion. It lets you write mobile games in Ruby for iOS and Android.</p> +<p>motion-game is a cross-platform mobile game engine for RubyMotion. It lets you write mobile games in Ruby for iOS, tvOS and Android.</p> <p>motion-game is currently in <strong>beta</strong>. Please give it a try and report problems you find to us.</p> <h2>Features</h2> <ul> <li><strong>Use Ruby :-)</strong> motion-game exposes a pure Ruby API to write games for mobile devices. You can write a video game all in Ruby.</li> -<li><strong>100% cross-platform</strong>: motion-game projects are fully cross-platform for iOS and Android. One codebase runs everywhere.</li> +<li><strong>100% cross-platform</strong>: motion-game projects are fully cross-platform for iOS, tvOS and Android. One codebase runs everywhere.</li> <li><strong>Fully-featured</strong>: motion-game has audio, sprites, animations, particles, device sensors / events, scene graph / director, UI widgets, etc.</li> <li><strong>Solid foundations</strong>: the motion-game API is implemented using popular and stable opensource libraries, such as <a href="http://www.cocos2d-x.org/">cocos2d-x</a>, <a href="http://box2d.org/">box2d</a>, and more. motion-game projects are also based on RubyMotion which offers portable Ruby runtimes for iOS and Android as well as static compilation of Ruby code.</li> <li><strong>Native compilation</strong>: your Ruby code will be compiled into optimized native code for each platform you target. There is no interpreter and the original Ruby code will not be in the app.</li> -<li><strong>Platform APIs access</strong>: if you need it, you can call the entire set of public iOS or Android APIs from Ruby code as well.</li> +<li><strong>Platform APIs access</strong>: if you need it, you can call the entire set of public iOS, tvOS or Android APIs from Ruby code as well.</li> </ul> <h2>Getting Started</h2> -<ul> -<li><a href="http://rubymotion.com">RubyMotion</a> is required. A starter version can be downloaded for free. You also need to set up your computer for mobile development (iOS and/or Android). Follow the <a href="http://rubymotion.com/developers">Getting Started</a> guides after installation.</li> -<li>Install motion-game: <code>$ gem install motion-game</code></li> -</ul> +<h3>Installing RubyMotion</h3> -<h2>Hello World</h2> +<p><a href="http://rubymotion.com">RubyMotion 4.7+</a> is required. A starter version can be downloaded for free. You also need to set up your computer for mobile development (iOS and/or tvOS and/or Android). Follow the <a href="http://rubymotion.com/developers">Getting Started</a> guides after installation.</p> +<h3>Installing motion-game</h3> + +<h4>Binaries</h4> + +<p>motion-game is available as a gem:</p> + +<pre class="code ruby"><code class="ruby">$ gem install motion-game +</code></pre> + +<h4>Source</h4> + +<p>You can build your own copy of motion-game:</p> + +<pre class="code ruby"><code class="ruby">$ rake build:setup +$ rake build:all +</code></pre> + +<h3>Hello World</h3> + <pre class="code ruby"><code class="ruby">$ motion create --template=motion-game HelloWorld $ cd HelloWorld -$ rake ios:simulator +</code></pre> + +<h4>iOS</h4> + +<pre class="code ruby"><code class="ruby">$ rake ios:simulator $ rake ios:device -$ rake android:emulator +</code></pre> + +<h4>tvOS</h4> + +<pre class="code ruby"><code class="ruby">$ rake tvos:simulator +$ rake tvos:device +</code></pre> + +<h4>Android</h4> + +<pre class="code ruby"><code class="ruby">$ rake android:emulator $ rake android:device </code></pre> -<h2>Samples</h2> +<h3>API reference</h3> -<p>Check out the <a href="https://github.com/HipByte/RubyMotionSamples/tree/master/game">HipByte/RubyMotionSamples/game</a> GitHub repository for samples.</p> +<p>The whole framework API is documented. The <a href="http://www.rubymotion.com/developers/motion-game/_index.html">API reference</a> is available online.</p> -<h2>About</h2> +<p>You can also build the API reference locally:</p> -<p>motion-game is developed by HipByte, the company that makes RubyMotion. It is currently available free of charge.</p> +<pre class="code ruby"><code class="ruby">$ rake doc +$ open doc/index.html +</code></pre> + +<h3>Samples</h3> + +<p>The <a href="https://github.com/HipByte/motion-game/tree/master/samples">samples</a> directory contains sample projects.</p> + +<h2>License</h2> + +<p>Copyright (c) 2015, HipByte (<a href="mailto:info@hipbyte.com">info@hipbyte.com</a>) and contributors. All rights reserved.</p> + +<p>Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:</p> + +<p>Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. +Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.</p> + +<p>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS &quot;AS IS&quot; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</p> </div></div> <div id="footer"> - Generated on Mon Sep 7 14:28:54 2015 by + Generated on Sun Feb 28 09:23:30 2016 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.8.7.6 (ruby-2.0.0). + 0.8.7.6 (ruby-2.2.3). </div> </body> </html> \ No newline at end of file