commit 9c4134e03098a0dce9a1ce2a6d9c008009d8cd41 parent f9bbf48930e2d47cb1a5e90231790c4f65caa710 Author: Amin Mesbah <dev@aminmesbah.com> Date: Wed, 11 Mar 2020 18:39:37 -0700 Add basic info to readme Diffstat:
| M | README.md | | | 33 | +++++++++++++++++++++++++++++++++ |
1 file changed, 33 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -1,3 +1,34 @@ +# Untitled Game + +This is an in-development 2D platformer. + +It currently supports these platforms: + +- Windows +- Linux +- Chrome and Firefox ([playable here][3]) + +Inspired by [Handmade Hero][4] and similar projects, I'm programming the game +largely from scratch. + + +## Controls + +- Move: Arrow keys +- Jump: S + + +## Cloning + +A git submodule is currently used to store the versioned game assets. + +``` +git clone --recurse-submodules https://git.amin.space/a-game/ +``` + + +## Compiling + ### Compile on Linux - Install clang and glfw3 with your system's package manager. @@ -30,3 +61,5 @@ lib/glfw_windows/ [1]: https://gist.github.com/InNoHurryToCode/955d63db0d79699fed63fe18eeebf17e [2]: https://www.glfw.org/download.html + [3]: https://www.amin.space/bin/a_game/ + [4]: https://handmadehero.org/