From 46c264203ece7bcc6e84564cc8752954048ffef6 Mon Sep 17 00:00:00 2001 From: Avik Sengupta Date: Tue, 28 Jul 2020 22:45:12 +0100 Subject: [PATCH] Add a little more documentation --- Project.toml | 3 ++- README.md | 7 +++++-- docs/src/api.md | 8 ++++++++ docs/src/index.md | 8 +++++++- 4 files changed, 22 insertions(+), 4 deletions(-) create mode 100644 docs/src/api.md diff --git a/Project.toml b/Project.toml index e7212ef..6fc64df 100644 --- a/Project.toml +++ b/Project.toml @@ -9,8 +9,9 @@ Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c" SimpleDirectMediaLayer = "98e33af6-2ee5-5afd-9e75-cbc738b767c4" [compat] -julia = "1.3" +Colors = "0.10, 0.11, 0.12" SimpleDirectMediaLayer = "0.2" +julia = "1.3" [extras] Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40" diff --git a/README.md b/README.md index f4f55e0..290b076 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,14 @@ A zero overhead game development framework for beginners. +## Overview +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. ## Status -This is an early development snapshot. Watch this space for improvements. +This is an early release. Please try to make interesting games with this, and report any issues or missing features. ## Acknowledgement -The design of this library is inspired by the python package [PyGameZero](https://pygame-zero.readthedocs.io) by [Daniel Pope](https://github.com/lordmauve). Some of the design has been changed to make things more Julian. The implementation is completely independent. \ No newline at end of file +The design of this library is inspired by the python package [PyGameZero](https://pygame-zero.readthedocs.io) by [Daniel Pope](https://github.com/lordmauve). Much of the design however has been changed to make things more Julian. The implementation is independent. \ No newline at end of file diff --git a/docs/src/api.md b/docs/src/api.md new file mode 100644 index 0000000..f79e3d0 --- /dev/null +++ b/docs/src/api.md @@ -0,0 +1,8 @@ +# Internal API + +```@index +``` + +```@autodocs +Modules = [GameZero] +``` diff --git a/docs/src/index.md b/docs/src/index.md index 89deba3..a27505f 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,8 +1,14 @@ -# GameZero.jl +# Zero overhead game development ```@index ``` +## Overview +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. + ```@autodocs Modules = [GameZero] ```