summaryrefslogtreecommitdiffhomepage
path: root/readme.md
diff options
context:
space:
mode:
authorAmir Rajan <[email protected]>2019-08-25 15:41:58 -0500
committerAmir Rajan <[email protected]>2019-08-25 15:41:58 -0500
commit755eaa0801d2bee225b797604b09f95166d18491 (patch)
tree38ff280413d7530ee8bd3bc7b349383244f7358e /readme.md
parent95f9b6f46e02c4c1bfb407dc256cbf09bb7285b8 (diff)
downloaddragonruby-game-toolkit-contrib-755eaa0801d2bee225b797604b09f95166d18491.tar.gz
dragonruby-game-toolkit-contrib-755eaa0801d2bee225b797604b09f95166d18491.zip
Make it so.
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..9ecdcc9
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,30 @@
+# How to Use
+
+This repository requires DragonRuby Game Toolkit. You can purchase a license from http://dragonruby.org.
+
+If your income is below $1000 per month, are a "student", or are a "big time Raspberry PI enthusiast", contact Amir at [email protected] with a short explanation of your current situation, and he'll set you up with a free license, no questions asked.
+
+1. Download DragonRuby Game Toolkit.
+2. Unzip.
+3. Navigate to your game folder using terminal (the default game folder is `./mygame/app`)
+4. `git clone https://github.com/DragonRuby/dragonruby-game-toolkit-contrib` or download and unzip into the `./mygame/app` directory.
+5. Your directory structures should look like the following:
+
+```
+DragonRuby
+|
++- mygame/
+ |
+ +- app/
+ |
+ +- main.rb
+ +- repl.rb
+ +- documentation/
+ |
+ +- dragon/ (this repository)
+ |
+ +- index.rb
+ +- other source files
+```
+
+5. Open `main.rb` and add the following to the top of the file: `require "app/dragon/index.rb"`