Cleaned up naming and formatting across scripts

jonjondev · Raelr · commit 91955ffc9af7 · 2023-07-23T20:22:28.000+10:00
diff --git a/.github/workflows/windows.yml b/.github/workflows/windows.yml
@@ -20,7 +20,7 @@ jobs:
     - uses: actions/checkout@v2
 
     - name: perform setup
-      run: ./scripts/Setup.ps1
+      run: ./scripts/setup.ps1
       
     - name: build all targets
       run: mingw32-make
diff --git a/README.md b/README.md
@@ -89,7 +89,7 @@ $ sudo apt install libasound2-dev mesa-common-dev libx11-dev libxrandr-dev libxi
     ```
     ```console
     // Windows
-    > ./scripts/Setup.ps1
+    > ./scripts/setup.ps1
     ```
 
 3. This should install all required dependencies. Once completed a `.env` file will be generated with all required variables. If the build is completed with no issue then you can proceed to build the project.
@@ -104,7 +104,7 @@ $ ./scripts/setup.sh --include-validation-layers
 ```
 ```console
 // Windows
-> ./scripts/Setup.ps1 -Include_Validation_Layers
+> ./scripts/setup.ps1 -Include_Validation_Layers
 ```
 
 **NOTE**: Building with this option can take some time to complete. Please be patient while the project builds the required validation layers.
diff --git a/make/Platform.mk b/make/Platform.mk
@@ -18,10 +18,10 @@ ifeq ($(OS), Windows_NT)
 	COPY = $(scriptsDir)/copy.bat $1 $2 $3
 	COPY_DIR = $(scriptsDir)/copy.bat --copy-directory $1 $2
 	VALIDATION_LAYERS_INSTALL_DIR := explicit_layer.d
-	BUILD_FLAGS_SCRIPT = $(scriptsDir)/buildFlags.bat
-	COMBINE_LIBS = powershell $(scriptsDir)/Combine-Libs.ps1 --src_libs $1 --src_objs $2 --output_dir $3 --output_name $4
+	BUILD_FLAGS_SCRIPT = $(scriptsDir)/buildflags.bat
+	COMBINE_LIBS = powershell $(scriptsDir)/combinelibs.ps1 --src_libs $1 --src_objs $2 --output_dir $3 --output_name $4
 else
-	COMBINE_LIBS = $(scriptsDir)/combine-libs.sh --src_libs $1 --src_objs $2 --output_dir $3 --output_name $4
+	COMBINE_LIBS = $(scriptsDir)/combinelibs.sh --src_libs $1 --src_objs $2 --output_dir $3 --output_name $4
 	# Check for MacOS/Linux
 	UNAMEOS := $(shell uname)
 	ifeq ($(UNAMEOS), Linux)
@@ -45,5 +45,5 @@ else
 	COPY = cp -r $1$(PATHSEP)$3 $2
 	COPY_DIR = $(call COPY,$1,$2,$3)
 	VALIDATION_LAYERS_INSTALL_DIR := lib/explicit_layer.d
-	BUILD_FLAGS_SCRIPT = $(scriptsDir)/buildFlags.sh
+	BUILD_FLAGS_SCRIPT = $(scriptsDir)/buildflags.sh
 endif
diff --git a/scripts/applyenv.sh b/scripts/applyenv.sh
@@ -1,5 +1,5 @@
 #!/bin/bash
-
+#
 # Copyright (c) 2022 Jonathan Moallem (@J-Mo63) & Aryeh Zinn (@Raelr)
 #
 # This code is released under an unmodified zlib license.
diff --git a/scripts/buildflags.bat b/scripts/buildflags.bat
@@ -34,7 +34,7 @@ echo %CXXFLAGS% > %TARGET_FILE%
 EXIT /B %ERRORLEVEL%
 
 :WriteError
-    echo "Requires at least two arguments (e.g. buildFlags.bat <target_dir> <cxxflags> <dirs>)"
+    echo "Requires at least two arguments (e.g. buildflags.bat <target_dir> <cxxflags> <dirs>)"
 EXIT /B 1
 
 ENDLOCAL
diff --git a/scripts/buildflags.sh b/scripts/buildflags.sh
@@ -1,13 +1,13 @@
 #!/bin/bash
-
+#
 # Copyright (c) 2022 Jonathan Moallem (@J-Mo63) & Aryeh Zinn (@Raelr)
 #
 # This code is released under an unmodified zlib license.
 # For conditions of distribution and use, please see:
 #     https://opensource.org/licenses/Zlib
 
 if [ $# -lt 3 ]; then
-  echo "Requires at least three arguments (e.g. buildFlags.sh <target_dir> <cxxflags> <dirs>)"
+  echo "Requires at least three arguments (e.g. buildflags.sh <target_dir> <cxxflags> <dirs>)"
   exit 1
 fi
 
diff --git a/scripts/combinelibs.ps1 b/scripts/combinelibs.ps1
@@ -1,3 +1,9 @@
+# Copyright (c) 2022 Jonathan Moallem (@J-Mo63) & Aryeh Zinn (@Raelr)
+#
+# This code is released under an unmodified zlib license.
+# For conditions of distribution and use, please see:
+#     https://opensource.org/licenses/Zlib
+
 [string[]] $targets = "*.obj", "*.o"
 
 function Make-Dir {
diff --git a/scripts/combinelibs.sh b/scripts/combinelibs.sh
@@ -1,4 +1,10 @@
 #!/bin/bash
+#
+# Copyright (c) 2022 Jonathan Moallem (@J-Mo63) & Aryeh Zinn (@Raelr)
+#
+# This code is released under an unmodified zlib license.
+# For conditions of distribution and use, please see:
+#     https://opensource.org/licenses/Zlib
 
 LIBS=""; OBJS=""; OUTPUT_NAME=""; OUTPUT_DIR=""; CURRENT_ARG=""
 
diff --git a/scripts/format.sh b/scripts/format.sh
@@ -1,5 +1,5 @@
 #!/bin/bash
-
+#
 # Copyright (c) 2022 Jonathan Moallem (@J-Mo63) & Aryeh Zinn (@Raelr)
 #
 # This code is released under an unmodified zlib license.
diff --git a/scripts/package.sh b/scripts/package.sh
@@ -1,5 +1,5 @@
 #!/bin/bash
-
+#
 # Copyright (c) 2022 Jonathan Moallem (@J-Mo63) & Aryeh Zinn (@Raelr)
 #
 # This code is released under an unmodified zlib license.
diff --git a/scripts/setup.ps1 b/scripts/setup.ps1
@@ -1,3 +1,9 @@
+# Copyright (c) 2022 Jonathan Moallem (@J-Mo63) & Aryeh Zinn (@Raelr)
+#
+# This code is released under an unmodified zlib license.
+# For conditions of distribution and use, please see:
+#     https://opensource.org/licenses/Zlib
+
 param (
     [switch] $Include_Validation_Layers
 )
@@ -38,9 +44,24 @@ function Checkout-Tags {
     git -C "$Path"  fetch --all --tags ; git -C "$Path" checkout tags/"$Tag"
 }
 
+function Setup-Raylib {
+    Write-Output "Setting up raylib..."
+    Write-Output "Cloning raylib..."
+    Update-Submodule -Submodule raylib-cpp
+}
+
+function Setup-Utest {
+    Write-Output "Setting up utest..."
+    Write-Output "Cloning utest..."
+    Update-Submodule -Submodule utest.h
+}
+
 function Setup-Zlib {
+    Write-Output "Setting up zlib..."
+    Write-Output "Cloning zlib..."
     Update-Submodule zlib
 
+    Write-Output "Building zlib..."
     [string] $build_dir = "$Vendor_Dir/zlib/build"
 
     Make-Dir $build_dir
@@ -53,8 +74,11 @@ function Setup-Zlib {
 }
 
 function Setup-LibPng {
+    Write-Output "Setting up libpng..."
+    Write-Output "Cloning libpng..."
     Update-Submodule libpng
 
+    Write-Output "Building libpng..."
     [string] $build_dir = "$Vendor_Dir/libpng/build"
 
     Make-Dir $build_dir
@@ -65,8 +89,11 @@ function Setup-LibPng {
 }
 
 function Setup-FreeType {
+    Write-Output "Setting up freetype..."
+    Write-Output "Cloning freetype..."
     Update-Submodule freetype
 
+    Write-Output "Building freetype..."
     [string] $build_dir = "$Vendor_Dir/freetype/build"
     [string] $zlib_build_dir = "$Vendor_Dir/zlib/build"
     [string] $libpng_build_dir = "$Vendor_Dir/libpng/build"
@@ -94,8 +121,11 @@ function Setup-FreeType {
 }
 
 function Setup-Glfw {
+    Write-Output "Setting up glfw..."
+    Write-Output "Cloning glfw..."
     Update-Submodule glfw
 
+    Write-Output "Building glfw..."
     [string] $build_dir = "$Vendor_Dir/glfw/build"
 
     cmake -G"$Generator" -DCMAKE_INSTALL_PREFIX="$build_dir" -B"$build_dir" -S"$Vendor_Dir/glfw"
@@ -104,8 +134,11 @@ function Setup-Glfw {
 }
 
 function Setup-Glslang {
+    Write-Output "Setting up glslang..."
+    Write-Output "Cloning glslang..."
     Update-Submodule glslang
 
+    Write-Output "Building glslang..."
     [string] $build_dir = "$Vendor_Dir/glslang/build"
 
     Make-Dir $build_dir
@@ -121,18 +154,24 @@ function Setup-Glslang {
 }
 
 function Setup-Volk {
+    Write-Output "Setting up volk..."
+    Write-Output "Cloning volk..."
     Update-Submodule vulkan/volk
 
+    Write-Output "Building volk..."
     Make-Dir $Volk_Include_Dir
 
     Copy-Item -Path "$Vulkan_Vendor_Dir/volk/volk.h" -Destination $Volk_Include_Dir
     Copy-Item -Path "$Vulkan_Vendor_Dir/volk/volk.c" -Destination $Volk_Include_Dir
 }
 
 function Setup-Vulkan-Headers {
+    Write-Output "Setting up Vulkan Headers..."
+    Write-Output "Cloning Vulkan Headers..."
     Update-Submodule vulkan/Vulkan-Headers
     Checkout-Tags "$Vulkan_Vendor_Dir/Vulkan-Headers" $Vulkan_Version
 
+    Write-Output "Building Vulkan Headers..."
     [string] $build_dir = "$Vulkan_Vendor_Dir/Vulkan-Headers/build"
 
     Make-Dir $build_dir
@@ -145,11 +184,14 @@ function Setup-Vulkan-Headers {
     Copy-Item -Path "$Vulkan_Vendor_Dir/Vulkan-Headers/include/vulkan/*" -Destination $Vulkan_Include_Dir -Include "*.h"
 }
 
-function Setup-Vulkan_Loader {
+function Setup-Vulkan-Loader {
+    Write-Output "Setting up Vulkan Loader..."
+    Write-Output "Cloning Vulkan Loader..."
     Update-Submodule vulkan/Vulkan-Loader
 
     Checkout-Tags "$Vulkan_Vendor_Dir/Vulkan-Loader" $Vulkan_Version
 
+    Write-Output "Building Vulkan Loader..."
     [string] $build_dir = "$Vulkan_Vendor_Dir/Vulkan-Loader/build"
 
     cmake `
@@ -165,10 +207,12 @@ function Setup-Vulkan_Loader {
     Copy-Item -Path "$build_dir/loader/Release/*" -Destination $Vulkan_Lib_Dir -Include "*.dll" -Recurse
 }
 
-function Setup-Robin-Hood-Hashing
-{
+function Setup-Robin-Hood-Hashing {
+    Write-Output "Setting up Robin Hood Hashing..."
+    Write-Output "Cloning Robin Hood Hashing..."
     Update-Submodule vulkan/robin-hood-hashing
 
+    Write-Output "Building Robin Hood Hashing..."
     [string] $build_dir = "$Vulkan_Vendor_Dir/robin-hood-hashing/build"
 
     cmake `
@@ -183,10 +227,13 @@ function Setup-Robin-Hood-Hashing
 }
 
 function Setup-Spirv-Headers {
+    Write-Output "Setting up SPIRV Headers..."
+    Write-Output "Cloning SPIRV Headers..."
     Update-Submodule vulkan/SPIRV-Headers
 
     Checkout-Tags "$Vulkan_Vendor_Dir/SPIRV-Headers" "sdk-1.3.231.1"
 
+    Write-Output "Building SPIRV Headers..."
     [string] $build_dir = "$Vulkan_Vendor_Dir/SPIRV-Headers/build"
 
     Make-Dir $build_dir
@@ -197,10 +244,13 @@ function Setup-Spirv-Headers {
 }
 
 function Setup-Spirv-Tools {
+    Write-Output "Setting up Spirv Tools..."
+    Write-Output "Cloning SPIRV Tools..."
     Update-Submodule vulkan/SPIRV-Tools
 
     Checkout-Tags "$Vulkan_Vendor_Dir/SPIRV-Tools" "$Spirv_Version"
 
+    Write-Output "Building SPIRV Tools..."
     [string] $build_dir = "$Vulkan_Vendor_Dir/SPIRV-Tools/build"
 
     Make-Dir $build_dir
@@ -211,10 +261,13 @@ function Setup-Spirv-Tools {
 }
 
 function Setup-Validation-Layers {
+    Write-Output "Setting up Vulkan Validation Layers..."
+    Write-Output "Cloning Vulkan ValidationLayers..."
     Update-Submodule vulkan/Vulkan-ValidationLayers
 
     Checkout-Tags "$Vulkan_Vendor_Dir/Vulkan-ValidationLayers" "$Vulkan_Version"
 
+    Write-Output "Building Vulkan Validation Layers..."
     [string] $build_dir = "$Vulkan_Vendor_Dir/Vulkan-ValidationLayers/build"
 
     Make-Dir $build_dir
@@ -240,60 +293,33 @@ function Setup-Validation-Layers {
     Copy-Item -Path "$build_dir/layers/Release/*" -Destination "$Vulkan_Lib_Dir/explicit_layer.d" -Include "*.dll" -Recurse
 }
 
-Write-Output "Setting up Dependencies"
+Write-Output "Setting up dependencies..."
 
 if (Test-Path "$Vulkan_Lib_Dir") { Remove-Item -Path "$Vulkan_Lib_Dir" -Recurse -Force }
 if (Test-Path "$Vulkan_Vendor_Dir/vulkan/include") { Remove-Item -Path "$Vulkan_Vendor_Dir/vulkan/include" -Recurse -Force }
 if (Test-Path "$Vendor_Dir/include") { Remove-Item -Path "$Vendor_Dir/include" -Recurse -Force }
 
-Write-Output "Setting up Raylib"
-Write-Output "Cloning Raylib"
-Update-Submodule -Submodule raylib-cpp
-
-Write-Output "Setting up utest"
-Write-Output "Cloning utest"
-Update-Submodule -Submodule utest.h
-
-Write-Output "Setting up zLib"
+Setup-Raylib
+Setup-Utest
 Setup-Zlib
-
-Write-Output "Setting up libpng"
 Setup-LibPng
-
-Write-Output "Setting up freetype"
 Setup-FreeType
-
-Write-Output "Setting up glfw"
 Setup-Glfw
-
-Write-Output "Setting up glslang"
 Setup-Glslang
-
-Write-Output "Setting up volk"
 Setup-Volk
-
-Write-Output "Setting up Vulkan-Headers"
 Setup-Vulkan-Headers
-
-Write-Output "Setting up Vulkan-Loader"
-Setup-Vulkan_Loader
+Setup-Vulkan-Loader
 
 if ($Include_Validation_Layers)
 {
-    Write-Output "Setting up Robin Hood Hashing"
     Setup-Robin-Hood-Hashing
-
-    Write-Output "Setting up Spirv-Headers"
     Setup-Spirv-Headers
-
-    Write-Output "Setting up Spirv-Tools"
     Setup-Spirv-Tools
-
-    Write-Output "Setting up Vulkan Validation Layers"
     Setup-Validation-Layers
 
+    Write-Output "Configuring environment file..."
     if (!(Test-Path "$Root_Dir/.env")) { New-Item -Path "$Root_Dir/.env" -ItemType file }
     Set-Content -Path "$Root_Dir/.env" -Value "VK_LAYER_PATH=$Bin_Dir\examples\render\build\lib\explicit_layer.d"
 }
 
-Write-Output "Configuring environment file"
+Write-Output "Siege setup complete"
diff --git a/scripts/setup.sh b/scripts/setup.sh

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`#!/bin/bash`
`2`		`-`
	`2`	`+#`
`3`	`3`	`# Copyright (c) 2022 Jonathan Moallem (@J-Mo63) & Aryeh Zinn (@Raelr)`
`4`	`4`	`#`
`5`	`5`	`# This code is released under an unmodified zlib license.`