-
Notifications
You must be signed in to change notification settings - Fork 476
Update docs and include a powershell setup script #94
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from 3 commits
f196e9e
fe53e42
25da8d7
a3ade03
615610c
a01a6ae
d74a202
6bf6714
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,17 +8,47 @@ Currently supports Windows - with macOS and Linux support planned. Setup scripts | |
| _<center>Forest Launcher - an application made with Walnut</center>_ | ||
|
|
||
| ## 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 | ||
| ``` | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🛠️ Refactor suggestion | 🟠 Major Clarify the distinction between setup options. The current wording creates confusion:
Additionally, the code blocks use 🔎 Proposed fix-*on Windows command line:*
+*from cmd.exe (Command Prompt):*
-``` bash
+``` cmd
./scripts/setup.ps1-on Windows Powershell: - 🧰 Tools🪛 markdownlint-cli2 (0.18.1)25-25: Emphasis style (MD049, emphasis-style) 25-25: Emphasis style (MD049, emphasis-style) 31-31: Emphasis style (MD049, emphasis-style) 31-31: Emphasis style (MD049, emphasis-style) 🤖 Prompt for AI Agents |
||
|
|
||
| *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 | ||
|
coderabbitai[bot] marked this conversation as resolved.
Outdated
|
||
|
|
||
| - [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)) | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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..." |
Uh oh!
There was an error while loading. Please reload this page.