You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-9Lines changed: 27 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,23 +10,27 @@ ui-sys: [](https://docs.rs/ui)
11
11
12
12
`iui` is a simple, small, easy to distribute GUI library, a Rusty user interface library that binds to platform native APIs.
13
-
These are work-in-progress bindings to the minimalistic native UI library [libui][libui] via the `ui-sys` bindings crate.
13
+
These are work-in-progress bindings to the minimalistic native UI library [libui](https://github.com/andlabs/libui) via the `ui-sys` bindings crate.
14
+
15
+
`libui` is a wrapper library for native(ish) GUI libraries:
16
+
17
+
* Win32API on Windows
18
+
* Cocoa on Mac OS X
19
+
* GTK+ on Linux and elsewhere
20
+
21
+
This library exposes a Rusty procedural interface to the "Least Common Denominator" of GUI widgets.
22
+
23
+
## Using
14
24
15
25
Add `iui` to your project with:
16
26
17
27
```toml
18
28
iui = "0.3"
19
29
```
20
30
21
-
## Organization
22
-
23
-
This repository contains multiple Rust crates. Also be sure to look at our [changelog](CHANGELOG.md) and learn [how to contribute](CONTRIBUTING.md).
31
+
We have documentation on [docs.rs](https://docs.rs/iui) for released versions and on [github](https://leotindall.github.io/libui-rs/iui/index.html) for master.
24
32
25
-
*`iui` is the safe Rust wrapper, to be used by most users.
26
-
*`ui-sys` is the raw unsafe bindings to the `libui` C code. Requires `cmake` so it can build `libui`.
27
-
*`libui` is included as a submodule.
28
33
29
-
Based on work by [@pcwalton](https://github.com/pcwalton/). Licensed MIT.
30
34
31
35
## Example
32
36
@@ -89,7 +93,17 @@ fn main() {
89
93
}
90
94
```
91
95
92
-
## Building ui-sys
96
+
## Organization
97
+
98
+
This repository contains multiple Rust crates:
99
+
100
+
*`iui` is the safe Rust wrapper, to be used by most users.
101
+
*`ui-sys` is the raw unsafe bindings to the `libui` C code. Requires `cmake` so it can build `libui`. `libui` is included as a submodule.
102
+
103
+
Also be sure to look at our [changelog](CHANGELOG.md) and learn [how to contribute](CONTRIBUTING.md).
104
+
105
+
106
+
### Building ui-sys
93
107
94
108
`ui-sys` includes `libui` as a sub-module and allows it to be built on-the-fly with the
95
109
default features `fetch` and `build. With `fetch disabled, it will simply build the
@@ -98,3 +112,7 @@ assuming either a system or local (in `./lib/`) version of `libui` is available.
98
112
99
113
Note that _most of the time_, building `libui` on the fly is what you want. It does however
100
114
require a copy of cmake, essential build tools, et cetera.
115
+
116
+
## Acknowledgments
117
+
118
+
Based on work by [@pcwalton](https://github.com/pcwalton/).
0 commit comments