From f196e9e9bb7501ef345b82bb45470d2199446f89 Mon Sep 17 00:00:00 2001 From: Ash Matheson Date: Fri, 19 Dec 2025 12:04:30 -0800 Subject: [PATCH 1/7] Update docs and include a powershell setup script --- README.md | 32 +++++++++++++++++++++++++++++++- scripts/setup.ps1 | 14 ++++++++++++++ 2 files changed, 45 insertions(+), 1 deletion(-) create mode 100644 scripts/setup.ps1 diff --git a/README.md b/README.md index 62896180..686e9852 100644 --- a/README.md +++ b/README.md @@ -8,17 +8,47 @@ Currently supports Windows - with macOS and Linux support planned. Setup scripts _
Forest Launcher - an application made with Walnut
_ ## Requirements + - [Visual Studio 2022](https://visualstudio.com) (not strictly required, however included setup scripts only support this) - [Vulkan SDK](https://vulkan.lunarg.com/sdk/home#windows) (preferably a recent version) ## Getting Started -Once you've cloned, run `scripts/Setup.bat` to generate Visual Studio 2022 solution/project files. Once you've opened the solution, you can run the WalnutApp project to see a basic example (code in `WalnutApp.cpp`). I recommend modifying that WalnutApp project to create your own application, as everything should be setup and ready to go. + +In order to clone the repository, you'll need to grab the submodules. So you'll need to do: + +``` bash +git clone --recurse-submodules https://github.com/StudioCherno/Walnut.git +``` + +Once you've cloned, run + +on Windows command line: + +``` bash +./scripts/setup.ps1 +``` + +on Windows Powershell: + +``` bash +./scripts/Setup.ps1 +``` + +or, if you have premake already installed: + +``` bash +premake5 vs2022 +``` + +to generate Visual Studio 2022 solution/project files. Once you've opened the solution, you can run the WalnutApp project to see a basic example (code in `WalnutApp.cpp`). I recommend modifying that WalnutApp project to create your own application, as everything should be setup and ready to go. ### 3rd party libaries + - [Dear ImGui](https://github.com/ocornut/imgui) - [GLFW](https://github.com/glfw/glfw) - [stb_image](https://github.com/nothings/stb) - [GLM](https://github.com/g-truc/glm) (included for convenience) ### Additional + - Walnut uses the [Roboto](https://fonts.google.com/specimen/Roboto) font ([Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)) \ No newline at end of file diff --git a/scripts/setup.ps1 b/scripts/setup.ps1 new file mode 100644 index 00000000..7b88a501 --- /dev/null +++ b/scripts/setup.ps1 @@ -0,0 +1,14 @@ +$ErrorActionPreference = "Stop" + +Push-Location "$PSScriptRoot\.." +try { + & "vendor\bin\premake5.exe" vs2022 +} +catch { + Write-Host "Error: $($_.Exception.Message)" -ForegroundColor Red +} +finally { + Pop-Location +} + +Read-Host "Press Enter to continue..." From fe53e42f90eb70edff2cdc99c815f9bda8dba866 Mon Sep 17 00:00:00 2001 From: Ash Matheson Date: Fri, 19 Dec 2025 12:04:30 -0800 Subject: [PATCH 2/7] Update docs and include a powershell setup script --- README.md | 32 +++++++++++++++++++++++++++++++- scripts/setup.ps1 | 14 ++++++++++++++ 2 files changed, 45 insertions(+), 1 deletion(-) create mode 100644 scripts/setup.ps1 diff --git a/README.md b/README.md index 62896180..c17e8154 100644 --- a/README.md +++ b/README.md @@ -8,17 +8,47 @@ Currently supports Windows - with macOS and Linux support planned. Setup scripts _
Forest Launcher - an application made with Walnut
_ ## Requirements + - [Visual Studio 2022](https://visualstudio.com) (not strictly required, however included setup scripts only support this) - [Vulkan SDK](https://vulkan.lunarg.com/sdk/home#windows) (preferably a recent version) ## Getting Started -Once you've cloned, run `scripts/Setup.bat` to generate Visual Studio 2022 solution/project files. Once you've opened the solution, you can run the WalnutApp project to see a basic example (code in `WalnutApp.cpp`). I recommend modifying that WalnutApp project to create your own application, as everything should be setup and ready to go. + +In order to clone the repository, you'll need to grab the submodules. To do that, you will need the following command line: + +``` bash +git clone --recurse-submodules https://github.com/StudioCherno/Walnut.git +``` + +Once you've cloned the repository, you can run one of the following setup scripts to generate Visual Studio 2022 solution/project files. + +*on Windows command line:* + +``` bash +./scripts/setup.ps1 +``` + +*on Windows Powershell:* + +``` bash +./scripts/Setup.ps1 +``` + +*or, if you have premake already installed:* + +``` bash +premake5 vs2022 +``` + +Once you've opened the solution, you can run the WalnutApp project to see a basic example (code in `WalnutApp.cpp`). I recommend modifying that WalnutApp project to create your own application, as everything should be setup and ready to go. ### 3rd party libaries + - [Dear ImGui](https://github.com/ocornut/imgui) - [GLFW](https://github.com/glfw/glfw) - [stb_image](https://github.com/nothings/stb) - [GLM](https://github.com/g-truc/glm) (included for convenience) ### Additional + - Walnut uses the [Roboto](https://fonts.google.com/specimen/Roboto) font ([Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)) \ No newline at end of file diff --git a/scripts/setup.ps1 b/scripts/setup.ps1 new file mode 100644 index 00000000..7b88a501 --- /dev/null +++ b/scripts/setup.ps1 @@ -0,0 +1,14 @@ +$ErrorActionPreference = "Stop" + +Push-Location "$PSScriptRoot\.." +try { + & "vendor\bin\premake5.exe" vs2022 +} +catch { + Write-Host "Error: $($_.Exception.Message)" -ForegroundColor Red +} +finally { + Pop-Location +} + +Read-Host "Press Enter to continue..." From a3ade0339a5dca9c385bcfec93f539afd50f021a Mon Sep 17 00:00:00 2001 From: Ash Matheson Date: Fri, 19 Dec 2025 12:14:17 -0800 Subject: [PATCH 3/7] adding clarification for coderabbitai --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c17e8154..ff0d9d33 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ git clone --recurse-submodules https://github.com/StudioCherno/Walnut.git Once you've cloned the repository, you can run one of the following setup scripts to generate Visual Studio 2022 solution/project files. -*on Windows command line:* +*on Windows command standard line (cmd.exe):* ``` bash ./scripts/setup.ps1 From 615610c50509802e42c2114021b0fa5f9a801294 Mon Sep 17 00:00:00 2001 From: Ash Matheson Date: Fri, 19 Dec 2025 12:15:54 -0800 Subject: [PATCH 4/7] Fixing a typo --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ff0d9d33..ae0f3a2c 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ Once you've cloned the repository, you can run one of the following setup script *on Windows command standard line (cmd.exe):* ``` bash -./scripts/setup.ps1 +./scripts/setup.bat ``` *on Windows Powershell:* @@ -42,7 +42,7 @@ premake5 vs2022 Once you've opened the solution, you can run the WalnutApp project to see a basic example (code in `WalnutApp.cpp`). I recommend modifying that WalnutApp project to create your own application, as everything should be setup and ready to go. -### 3rd party libaries +### 3rd party libraries - [Dear ImGui](https://github.com/ocornut/imgui) - [GLFW](https://github.com/glfw/glfw) From a01a6aea88c9f2dec91e8b7eb46325ab8b190cb2 Mon Sep 17 00:00:00 2001 From: Ash Matheson Date: Fri, 19 Dec 2025 12:22:40 -0800 Subject: [PATCH 5/7] docs: clarify cloning instructions and correct command block languages in README. --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index ae0f3a2c..2065dfea 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ _
Forest Launcher - an application made with Walnut
_ ## Getting Started -In order to clone the repository, you'll need to grab the submodules. To do that, you will need the following command line: +In order to fuly clone the repository run the following command: ``` bash git clone --recurse-submodules https://github.com/StudioCherno/Walnut.git @@ -22,21 +22,21 @@ git clone --recurse-submodules https://github.com/StudioCherno/Walnut.git Once you've cloned the repository, you can run one of the following setup scripts to generate Visual Studio 2022 solution/project files. -*on Windows command standard line (cmd.exe):* +_on Windows using the command prompt cmd.exe:_ -``` bash -./scripts/setup.bat +``` cmd +./scripts/Setup.bat ``` -*on Windows Powershell:* +_on Windows Powershell:_ -``` bash +``` powershell ./scripts/Setup.ps1 ``` -*or, if you have premake already installed:* +_or, if you have premake already installed:_ -``` bash +``` powershell premake5 vs2022 ``` From d74a202b9eba9571751a4238ba45cec652ddad75 Mon Sep 17 00:00:00 2001 From: Ash Matheson Date: Fri, 19 Dec 2025 12:25:21 -0800 Subject: [PATCH 6/7] One. Last. Typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2065dfea..f9e97da2 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ _
Forest Launcher - an application made with Walnut
_ ## Getting Started -In order to fuly clone the repository run the following command: +In order to fully clone the repository run the following command: ``` bash git clone --recurse-submodules https://github.com/StudioCherno/Walnut.git From 6bf671407e6434aaeafdb943f8be6f55cdced1cb Mon Sep 17 00:00:00 2001 From: Ash Matheson Date: Fri, 19 Dec 2025 15:14:54 -0800 Subject: [PATCH 7/7] correct script casing in README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f9e97da2..a2049f05 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ _on Windows using the command prompt cmd.exe:_ _on Windows Powershell:_ ``` powershell -./scripts/Setup.ps1 +./scripts/setup.ps1 ``` _or, if you have premake already installed:_