From 94a0a75d6991e3f38215f4cb36433229ed3b8f58 Mon Sep 17 00:00:00 2001 From: Jeffery Myers Date: Mon, 18 Nov 2024 15:48:51 -0800 Subject: [PATCH 1/4] typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 56728dd..fb1a2d0 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Quickstart supports the main 3 desktop platforms * You are good to go. # Windows Users -There are two compiler toolchains avialble for windows, MinGW-W64 (a free compiler using GCC), and Microsoft Visual Studio +There are two compiler toolchains available for windows, MinGW-W64 (a free compiler using GCC), and Microsoft Visual Studio ## Using MinGW-W64 * Double click the build-MinGW-W64.bat file. * cd into the folder in your terminal From e16a76fb9494ee3c3ed103a63474c0c031ebf0a6 Mon Sep 17 00:00:00 2001 From: "Ricardo Q. Bazan" Date: Wed, 20 Nov 2024 19:54:11 -0500 Subject: [PATCH 2/4] fix(config): vscode task --- .vscode/tasks.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vscode/tasks.json b/.vscode/tasks.json index f842d09..c4a5d0e 100644 --- a/.vscode/tasks.json +++ b/.vscode/tasks.json @@ -40,7 +40,7 @@ }, "osx": { "args": [ - "config=release_ARM64" + "config=release_arm64" ], }, "group": "build", From ec8968b0f3c93177991f8b8f0252035d552c4c2e Mon Sep 17 00:00:00 2001 From: Nathan Iszlaub Date: Sat, 23 Nov 2024 23:53:41 +0800 Subject: [PATCH 3/4] fix minor typos and adjust casing+punctuation for consistency --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index fb1a2d0..fb544ba 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ A simple cross platform template for setting up a project with the bleeding edge Works with C or C++. ## Supported Platforms -Quickstart supports the main 3 desktop platforms +Quickstart supports the main 3 desktop platforms: * Windows * Linux * MacOS @@ -11,15 +11,15 @@ Quickstart supports the main 3 desktop platforms # VSCode Users (all platforms) * Download the quickstart * Rename the folder to your game name -* Open the folder in VSCode. +* Open the folder in VSCode * Press F5 to build -* You are good to go. +* You are good to go # Windows Users There are two compiler toolchains available for windows, MinGW-W64 (a free compiler using GCC), and Microsoft Visual Studio ## Using MinGW-W64 * Double click the build-MinGW-W64.bat file. -* cd into the folder in your terminal +* CD into the folder in your terminal * run make * You are good to go @@ -28,20 +28,20 @@ Make sure you have a modern version of MinGW-W64 (not mingw). The best place to get it is from the W64devkit from https://github.com/skeeto/w64devkit/releases or the version installed with the raylib installer -#### If you have installed rayib from the installer +#### If you have installed raylib from the installer Make sure you have added the path - C:\raylib\w64devkit\bin +C:\raylib\w64devkit\bin -To your path environment varialbe so that the compiler that came with raylib can be found.. +To your path environment variable so that the compiler that came with raylib can be found. -DO NOT INSALL ANOTHER MinGW-W64 from another source such as msys2, you don't need it. +DO NOT INSTALL ANOTHER MinGW-W64 from another source such as msys2, you don't need it. ## Microsoft Visual Studio -* Run the build-VisualStudio2022.bat -* double click the .sln file that is geneated. +* Run `build-VisualStudio2022.bat` +* double click the `.sln` file that is generated * develop your game -* you are good to go. +* you are good to go # Linux Users * CD into the build folder @@ -70,7 +70,7 @@ Simply rename src/main.c to src/main.cpp and re-run the steps above and do a cle Simply remove src/main.c and replace it with your code, and re-run the steps above and do a clean build. # Building for other OpenGL targets -If you need to build for a different OpenGL version than the default (OpenGL 3.3) you can specify an openGL version in your premake command line. Just modify the bat file or add the following to your command line +If you need to build for a different OpenGL version than the default (OpenGL 3.3) you can specify an OpenGL version in your premake command line. Just modify the bat file or add the following to your command line ## For OpenGL 1.1 --graphics=opengl11 From 312433ae8b0d013a8f80ef8a03712bc44ccd7c36 Mon Sep 17 00:00:00 2001 From: Nathan Iszlaub Date: Sun, 24 Nov 2024 00:00:41 +0800 Subject: [PATCH 4/4] use code formatting for commands, files, and paths --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index fb544ba..201bd83 100644 --- a/README.md +++ b/README.md @@ -18,9 +18,9 @@ Quickstart supports the main 3 desktop platforms: # Windows Users There are two compiler toolchains available for windows, MinGW-W64 (a free compiler using GCC), and Microsoft Visual Studio ## Using MinGW-W64 -* Double click the build-MinGW-W64.bat file. +* Double click the `build-MinGW-W64.bat` file * CD into the folder in your terminal -* run make +* run `make` * You are good to go ### Note on MinGW-64 versions @@ -31,7 +31,7 @@ or the version installed with the raylib installer #### If you have installed raylib from the installer Make sure you have added the path -C:\raylib\w64devkit\bin +`C:\raylib\w64devkit\bin` To your path environment variable so that the compiler that came with raylib can be found. @@ -45,47 +45,47 @@ DO NOT INSTALL ANOTHER MinGW-W64 from another source such as msys2, you don't ne # Linux Users * CD into the build folder -* run ./premake5 gmake2 +* run `./premake5 gmake2` * CD back to the root -* run make +* run `make` * you are good to go # MacOS Users * CD into the build folder -* run ./premake5.osx gmake2 +* run `./premake5.osx gmake2` * CD back to the root -* run make +* run `make` * you are good to go # Output files The built code will be in the bin dir # Working directories and the resources folder -The example uses a utility function from path_utils.h that will find the resources dir and set it as the current working directory. This is very useful when starting out. If you wish to manage your own working directory you can simply remove the call to the function and the header. +The example uses a utility function from `path_utils.h` that will find the resources dir and set it as the current working directory. This is very useful when starting out. If you wish to manage your own working directory you can simply remove the call to the function and the header. # Changing to C++ -Simply rename src/main.c to src/main.cpp and re-run the steps above and do a clean build. +Simply rename `src/main.c` to `src/main.cpp` and re-run the steps above and do a clean build. # Using your own code -Simply remove src/main.c and replace it with your code, and re-run the steps above and do a clean build. +Simply remove `src/main.c` and replace it with your code, and re-run the steps above and do a clean build. # Building for other OpenGL targets If you need to build for a different OpenGL version than the default (OpenGL 3.3) you can specify an OpenGL version in your premake command line. Just modify the bat file or add the following to your command line ## For OpenGL 1.1 ---graphics=opengl11 +`--graphics=opengl11` ## For OpenGL 2.1 ---graphics=opengl21 +`--graphics=opengl21` ## For OpenGL 4.3 ---graphics=opengl43 +`--graphics=opengl43` ## For OpenGLES 2.0 ---graphics=opengles2 +`--graphics=opengles2` ## For OpenGLES 3.0 ---graphics=opengles3 +`--graphics=opengles3` # License Copyright (c) 2020-2024 Jeffery Myers