summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorRay <[email protected]>2021-06-30 20:29:48 +0200
committerGitHub <[email protected]>2021-06-30 20:29:48 +0200
commit6bed2ec034ff3f0694c07428617357044d1a59e5 (patch)
tree070a2d969da57ac448b45faf885e93ff9fba0d26 /README.md
parent77efd7a909924c9cd9c25cec5820319ce0b949a7 (diff)
downloadraylib-game-template-6bed2ec034ff3f0694c07428617357044d1a59e5.tar.gz
raylib-game-template-6bed2ec034ff3f0694c07428617357044d1a59e5.zip
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 15 insertions, 1 deletions
diff --git a/README.md b/README.md
index 4afd8cb..6ca93d6 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,17 @@
+-----------------------------------
+
+Welcome to **raylib game template**!
+
+This template provides a base structure to start developing a small raylib game in plain C. The repo is also pre-configured with a default `LICENSE` and a `README.md` (this one) to be filled with the required game information by users.
+
+All the sections defined by `$(Data to Fill)` are expected to be edited and filled properly. It's recommended to delete this disclaimer message from the game repo using this template.
+
+This example has been created to be used with raylib (www.raylib.com) and it's licensed under an unmodified zlib/libpng license.
+
+_Copyright (c) 2014-2021 Ramon Santamaria ([@raysan5](https://twitter.com/raysan5))_
+
+-----------------------------------
+
## $(Game Title)
![$(Game Title)](screenshots/screenshot000.png "$(Game Title)")
@@ -23,4 +37,4 @@ Keyboard:
This game sources are licensed under an unmodified zlib/libpng license, which is an OSI-certified, BSD-like license that allows static linking with closed source software. Check [LICENSE](LICENSE) for further details.
-*Copyright (c) 2014-2021 Ramon Santamaria ([@raysan5](https://twitter.com/raysan5))* \ No newline at end of file
+*Copyright (c) $(Year) $(User Name) ($(User Twitter/GitHub Name))*