Skip to content

Commit

Permalink
REQ: Installation instructions in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pe-pan committed Dec 12, 2016
1 parent 8f96b38 commit e7a3aa6
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,17 @@ This source code is based on a <a href="https://sourceforge.net/projects/flappy/
originally disassembled and rewritten from Z80 machine code by <a href="http://www.8bit-times.eu/">Petr &#x160;lechta</a>.
<br>

<h2>Installation instructions</h2>
From copyright reasons, this game is not hosted in Google Play Store; to install Flappy in your Android device (version 2.3.3 and above), follow the instructions below:
<ol>
<li>At your device, enable installing application from unknown sources.<br>
For instructions, see <a href="http://www.androidcentral.com/allow-app-installs-unknown-sources">here</a>.</li>
<li>Open this page - <i>https://github.com/pe-pan/flappy</i> - in your Android device</li>
<li>Click on <a href="https://github.com/pe-pan/flappy/releases/download/v0.3-alpha/application-debug.apk">this link</a></li>
<li>Confirm the installation</li>
</ol>

<h2>Differences from original</h2>
The code contains the original Flappy game with several improvements to reflect Android platform differences.
<ol>
<li>Finger gestures simulate keyboard arrows (to move Flappy around)</li>
Expand All @@ -15,6 +26,7 @@ The code contains the original Flappy game with several improvements to reflect
<li>Hi-score screen showing scores shared with other players</li>
</ol>

<h2>Code structure</h2>
The code is split into following modules:
<ul>
<li><b>core</b> - contains the Java version of Flappy made by Petr &#x160;lechta
Expand Down Expand Up @@ -52,4 +64,7 @@ The code is split into following modules:
</li>
</ul>

<h2>Contact</h2>
For feedback or bug reports, contact <a href="http://panuska.net">Petr Panu&#x161;ka</a>.
<br>
&copy; 2016 <a href="http://panuska.net">Petr Panu&#x161;ka</a>

0 comments on commit e7a3aa6

Please sign in to comment.