]> bicyclesonthemoon.info Git - ott/molpy-up/commitdiff
added README
authorPeter Gerwinski <peter.gerwinski@hs-bochum.de>
Thu, 29 Mar 2018 14:20:44 +0000 (16:20 +0200)
committerPeter Gerwinski <peter.gerwinski@hs-bochum.de>
Thu, 29 Mar 2018 14:20:44 +0000 (16:20 +0200)
README [new file with mode: 0644]

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..dfc31f5
--- /dev/null
+++ b/README
@@ -0,0 +1,31 @@
+Welcome to Molpy Up!
+
+This is an OTTified version of Max00355's version of DoodleJump,
+<https://github.com/Max00355/DoodleJump>.
+(For the meaning of "OTTified", see <http://xkcd-time.wikia.com>.)
+
+This software is Free Software under the GNU GPL v3.
+Parts of the artwork are under a different license (non-Free, unfortunately).
+See the source (molpyup.py) for details.
+
+To run this software, you need a Python interpreter (version 2 or 3)
+and the pygame library.
+
+ * Under Debian GNU/Linux or a compatible OS,
+   type "sudo apt-get install python pygame".
+   To run the game, type "python molpyup.py".
+
+ * Under Apple MacOS, type "sudo easy_install pygame".
+   To run the game, type "python molpyup.py".
+   See <http://forums.xkcd.com/viewtopic.php?p=4331564#p4331564> for details.
+
+ * Under Microsoft Windows, download a Python interpreter from
+   <https://www.python.org/downloads/>, and install it.
+   Then type "py -m pip install -U pygame --user" in a command line
+   to install the pygame library.
+   To run the game, click on "molpyup.py"
+   See <http://forums.xkcd.com/viewtopic.php?p=4331549#p4331549> for details.
+
+In the game, use the left and right arrow keys to navigate.
+
+Enjoy!