Skip to content

Commit

Permalink
Another update to the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sebh committed Jul 23, 2018
1 parent f951cb5 commit 5e60037
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,20 @@

![dx11appscreenshot](https://github.com/sebh/Dx11Base/blob/master/DX11Application.png)

A small dx11 base program I use to test shaders and techniques (windows Dx11 only).
It is meant to be simple and extended to your needs (nothing fancy here).
A small DirectX 11 program I use to test shaders and techniques (windows only). It is meant to be simple and extended to your needs. Nothing fancy to see here: plenty of _engines_ already exist out there.

Features are
* Simple class helpers above DirectX 11.X functions.
* Live update of shaders upon saving (via ctrl+s)
* UI achieved with [imgui](https://github.com/ocornut/imgui)
* Simple class helpers above DirectX 11.X functions
* Live update of shaders with saving via `ctrl+s`
* UI achieved with [Dear ImGui](https://github.com/ocornut/imgui)
* Performance measured with GPU timers and reported in UI (tested on intel and nvidia so far)
* Simple window and input management (could be improved)

When cloning the project the first time
* Update submodules (run `git submodule update`)
* In Visual Studio, change the _Application_ project _Working Directory_ from `$(ProjectDir)` to `$(SolutionDir)`
When cloning the project the first time:
1. Update submodules (run `git submodule update`)
2. In Visual Studio, change the _Application_ project _Working Directory_ from `$(ProjectDir)` to `$(SolutionDir)`

Submodules (do not forget to run `git submodule update`)
Submodules
* [imgui](https://github.com/ocornut/imgui) V1.62

Have fun and do not hesitate to send back suggestions.
Expand Down

0 comments on commit 5e60037

Please sign in to comment.