Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MurkyYT authored Dec 19, 2023
1 parent c4c665a commit ee9addd
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# **MUI** (*Murky User Interface*)
**MUI** is a custom made GUI framework i made in c++ which is built on top of the win32 windows api

(*the code is probably shit but at least it works :), if you have any code improvments i'll be happy*)
## Features
* Support new style
* If you want to disable it change `#define NEW_STYLE 1` to `#define NEW_STYLE 0`
* Window
* You can change its minimal size and maximal size
* You can change its title and icon
* You can select whether or not hide on close (inside `MUI.h` change `#define HIDE_ON_CLOSE 0` to `#define HIDE_ON_CLOSE 1`)
* Kind of components based system with callbacks
* Components list:
* Button
* CheckBox
* Grid (you have to explicitly set the grid by using `window->SetGrid(&grid)` as in the test project, grid currently is very experimental and will probably change overtime)
* Image
* ListView
* RadioGroup
* RadioButton
* TextBlock
* TextBox
* Custom coloring of each component type(works best with `#define NEW_STYLE 0` )
## Demo project
*You can find a demo project inside the `Test` folder, this project is where i test new features and additions*

![demo-image](example.png)

## Building instructions
1. Download Visual Studio 2022 with Windows 11 SDK (10.0.22000.0)
2. Open the `MUI.sln` solution file
3. Build and compile!

0 comments on commit ee9addd

Please # to comment.