more docs, new version

aviks · Aug 19, 2020 · 4106c47 · 4106c47 · aviks · Aug 19, 2020
1 parent 33094c6
commit 4106c47
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "GameZero"
 uuid = "9da27670-f782-11e9-1da1-f53579315bfe"
 authors = ["Avik Sengupta", "Ahan Sengupta"]
-version = "0.1.1"
+version = "0.1.2"
 
 [deps]
 Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -4,7 +4,22 @@
 The aim of this package is to remove accidental complexity from the game development process. We therefore always choose simplicity and consistency over features. The users of this package will include young programmers learning their first language, maybe moving up from Scratch. While we aim to support reasonably sophisticated 2D games, our first priority will remain learners, and their teachers.
 
 ## Example
-The best way to learn how to use this package is by looking at code. There are some simple examples in the [example subdirectory](https://github.com/aviks/GameZero.jl/tree/master/example/BasicGame). More comprehensive examples are listed in the [GZExamples](https://github.com/SquidSinker/GZExamples) repository.
+The best way to learn how to use this package is by looking at code. There are some simple examples in the [example subdirectory](https://github.com/aviks/GameZero.jl/tree/master/example/BasicGame). More comprehensive examples are listed in the [GZExamples](https://github.com/SquidSinker/GZExamples) repository. The example source code can also be viewed as part of this documentation -- see the menu on the left. 
+
+## Running Games
+
+Games created using GameZero are `.jl` files that live in any directory. To play the games, start the Julia REPL and:
+
+```
+pkg> add GameZero
+
+pkg> add Colors
+
+julia> using GameZero
+
+julia> rungame("C:\\path\\to\\game\\Spaceship\\Spaceship.jl")
+
+```
 
 ## Assets
 ![](assets/directory_structure.png)