diff --git a/README.md b/README.md index 62896180..a2049f05 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. -### 3rd party libaries +In order to fully clone the repository run the following command: + +``` 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 using the command prompt cmd.exe:_ + +``` cmd +./scripts/Setup.bat +``` + +_on Windows Powershell:_ + +``` powershell +./scripts/setup.ps1 +``` + +_or, if you have premake already installed:_ + +``` powershell +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 libraries + - [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..."