Samuel Dionne-Riel  committed 7966a55

Updated readme; it was a bit out of date.

  • Participants
  • Parent commits a6556fb
  • Branches default

Comments (0)

Files changed (2)

+<!-- -*- markdown -*- -->
+RedBox Application Project
+*Version: Development snapshot*
+This project is a template project to make a game using the RedBox Engine.
+For any help, you can go to [the website](, which is
+the documentation website or you can use [our forums](
+and make your mark in the community.
+When you find a bug with our engine or anything we do, you should post a bug
+report on [our bug tracker](
+License information
+For license details about RedBox, see the wiki or the license.txt file.
+The example main.cpp and Loader.h file are released as either Public Domain or
+MIT License, whichever better fits your needs.
+More details
+Folder structure
+	/application/    -> Your game code goes there.
+	     Loader.h    -> Some start-up configurations for RedBox are made there.
+	/resources/      -> Your resources goes there. (e.g Sounds, Art, etc.)
+	/ide/            -> The project templates are found there. You should only
+	                    have to open them with your IDE and start coding.
+	                    The folders are named following this convention:
+	                                  [IDE NAME]-[PLATFORM]
+	                    When a project file is platform agnostic (works on
+	                    windows, linux and osx, for example) it will only be
+	                    named after the IDE.
+	/libraries/      -> This is where the local libraries are.
+	                    (generally this means RedBox and sigly)

File readme.txt

-This project is a template project to make a game using the RedBox engine. 
-For any help:
- (Documentation / wiki)
- (Forum)
-If you find a bug:
- (bug tracker)
-For license detail see the wiki or license.txt
-Project structure:
-- application/ 			(Your code goes there)
-	Loader.h 			(Edit this file to load your game)
-- resources/ 			(Your resources goes there. Ex: soundFX, art, etc.)
-- ide/ 					(ide projects, we are implementing CMake to generate those project automaticly, so we won't need this folder in the near future)
-- libraries/ 			(put your needed libraries there, it should at least contain the redbox engine)