Merge pull request #11 from Daft-Freak/patch-1

Minor changes

CMakeLists.txt

@@ -1,9 +1,16 @@
 # Basic parameters; check that these match your project / environment
-cmake_minimum_required(VERSION 3.8)
+cmake_minimum_required(VERSION 3.9)
 
+# Replace "game" with a name for your project (this is used the name of the output)
 project(game)
-set(32BLIT_PATH "../" CACHE PATH "Path to 32blit.cmake")
+
+# This is the default value for 32BLIT_PATH, usually you would set this through -D32BLIT_PATH=the/path, but you can change the default here for convenience
+set(32BLIT_PATH "../" CACHE PATH "Path to the directory containing 32blit.cmake")
+
+# Add your sources here (adding headers is optional, but helps some CMake generators)
 set(PROJECT_SOURCE game.cpp game.hpp)
+
+# ... and any other files you want in the release here
 set(PROJECT_DISTRIBS LICENSE README.md)
 
 # Build configuration; approach this with caution!

README.md

@@ -22,3 +22,12 @@ generate your own project.
 
 You should then be able to follow the usual build instructions.
 
+For local builds this is:
+```
+mkdir build
+cd build
+cmake -D32BLIT_PATH=/path/to/32blit/ ..
+```
+
+Platform/Editor specific insctuctions [can be found in the main 32blit repo](https://github.com/pimoroni/32blit-beta#more-docs)
+(For Visual Studio, you should follow the "Option 2" instructions, as the boilerplate does not contain a solution file)

metadata.yml

@@ -6,4 +6,5 @@ splash:
 icon:
   file: assets/no-icon.png
 version: v0.0.1
-
+category: game # game, demo, utility, ...
+url: https://github.com/32blit/32blit-boilerplate