Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PixelSenseiAvi committed Dec 28, 2022
1 parent 142c8cf commit 9e4c156
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

GLADWalnut is a simple application framework built with Dear ImGui and designed to be used with GLAD - basically this means you can seemlessly blend real-time GLAD rendering with a great UI library to build desktop applications. The plan is to expand Walnut to include common utilities to make immediate-mode desktop apps and simple GLAD applications. This is inspired from @TheCherno Walnut which was written in Vulkan api.

Currently supports Windows - with macOS and Linux support planned. Setup scripts support Visual Studio 2022 by default.
Currently supports Windows & Linux - with macOS planned. Setup scripts support Visual Studio 2022 by default.

## Requirements
- [Visual Studio 2022](https://visualstudio.com) (not strictly required, however included setup scripts only support this)

## 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.
Once you've cloned, run `scripts/Setup.bat` to generate Visual Studio 2022 solution/project files. You can use CMAKE for building project on linux. 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)
Expand Down

0 comments on commit 9e4c156

Please sign in to comment.