From b177c27616bbe3fdbf7ed28b1c5a275498cd8cdd Mon Sep 17 00:00:00 2001 From: BennyQBD Date: Fri, 4 Jul 2014 23:12:25 -0400 Subject: [PATCH] Updated README --- C++CodingStyleGuide.txt | 12 +++--------- README.md | 5 +++-- 2 files changed, 6 insertions(+), 11 deletions(-) diff --git a/C++CodingStyleGuide.txt b/C++CodingStyleGuide.txt index f0b88da..bcfed56 100644 --- a/C++CodingStyleGuide.txt +++ b/C++CodingStyleGuide.txt @@ -206,12 +206,11 @@ Variables: Reasoning: Pointers are more clear if thought of as a type. - -'const' should be used whenever and wherever possible, except where otherwise noted. 'const' variables - should be written in all caps, with underscores separating words. - Use this: const float START_VAL = 0.37f; + -'const' should be used whenever and wherever possible, except where otherwise noted. + Use this: const float startVal = 0.37f; Instead of: float startVal = 0.37f; - Reasoning: Clear indicator that value should not be changed. Useful for both preventing bugs + Reasoning: Clear indicator that value should not need to be changed. Useful for both preventing bugs and enabling compiler optimizations. @@ -563,11 +562,6 @@ Enums: START_LOC3, START_SIZE }; - - -If an enum is associated with a particular class or namespace, it should be placed - in that particular class or namespace. However, it should not have a unique namespace - created just to "name" the enum. - Reasoning: To be added Defines/Macros: diff --git a/README.md b/README.md index 696de6a..3023593 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ brew install cmake glew sdl2 assimp ##Simple Build Instructions## ###Mac OSX/Linux/Unix### -Open a Terminal and run: +- Open a Terminal and run: ```Shell # install dependencies @@ -42,10 +42,11 @@ Open a Terminal and run: #or you can use -G "CodeBlocks - Unix Makefiles" to generate a CodeBlocks Project. #See http://www.cmake.org/ for more details about CMake arguments ``` +- If this fails for any reason, try using the Manual Build Instructions below. ###Windows### - Make sure CMake has been installed, and added to the system PATH. -- Run "Windows-GenVisualStudioProject.bat" +- Run "Windows-GenVisualStudioProject.bat" If this fails for any reason, try using the Manual Build Instructions below. - Go to the build folder, and open 3DEngineCpp.sln with Visual Studio 2012 or newer (For older versions of Visual Studio, use manual build instructions) - Right click on the 3DEngineCpp project, and select "Set as start up project" - Build and Run