Skip to content

Commit 300fb95

Browse files
committed
added more readme
1 parent 6bb5e23 commit 300fb95

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,50 @@ This crate is a collection of examples for [imgui](https://github.com/imgui-rs/i
44
Much more information on how to use `imgui` can be found at that repository. This repository
55
can show examples of how to use `imgui`'s API and, to a lesser extent, how to setup an
66
`imgui` platform and renderer.
7+
8+
## Quick Start
9+
10+
To start seeing these examples in action, simply run:
11+
12+
```sh
13+
cargo run --example hello_world;
14+
```
15+
16+
The following examples are available now:
17+
18+
```txt
19+
collapsing_header
20+
color_button
21+
creating_windows
22+
custom_textures
23+
disablement
24+
draw_list
25+
empty
26+
hello_world
27+
id_wrangling
28+
keyboard
29+
long_list
30+
long_table
31+
multiple_fonts
32+
progress_bar
33+
radio_button
34+
slider
35+
tables_api
36+
test_drawing_channels_split
37+
test_window
38+
test_window_impl
39+
text_callbacks
40+
text_input
41+
```
42+
43+
## License
44+
45+
Licensed under either of
46+
47+
- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or https://www.apache.org/licenses/LICENSE-2.0)
48+
- MIT license ([LICENSE-MIT](LICENSE-MIT) or https://opensource.org/licenses/MIT)
49+
50+
at your option.
51+
52+
Uses [Dear ImGui](https://github.com/ocornut/imgui) and
53+
[cimgui](https://github.com/cimgui/cimgui).

0 commit comments

Comments
 (0)