Skip to content

Commit c6341ad

Browse files
authored
Merge pull request #21 from LeoTindall/improve-readme
Improve README
2 parents 551669e + f8553af commit c6341ad

File tree

2 files changed

+28
-10
lines changed

2 files changed

+28
-10
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ No additional API surface.
1212

1313
### Changed
1414

15-
No API changes.
15+
* README.md now links to libui, and is more explanatory
1616

1717
### Deprecated
1818

README.md

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,27 @@ ui-sys: [![ui-sys crates.io version badge](https://img.shields.io/crates/v/ui-sy
1010
[![docs.rs for ui-sys](https://docs.rs/ui-sys/badge.svg)](https://docs.rs/ui)
1111

1212
`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
1424

1525
Add `iui` to your project with:
1626

1727
```toml
1828
iui = "0.3"
1929
```
2030

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.
2432

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.
2833

29-
Based on work by [@pcwalton](https://github.com/pcwalton/). Licensed MIT.
3034

3135
## Example
3236

@@ -89,7 +93,17 @@ fn main() {
8993
}
9094
```
9195

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
93107

94108
`ui-sys` includes `libui` as a sub-module and allows it to be built on-the-fly with the
95109
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.
98112

99113
Note that _most of the time_, building `libui` on the fly is what you want. It does however
100114
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

Comments
 (0)