Updated README
This commit is contained in:
parent
07e53ddadd
commit
63680b5696
1 changed files with 35 additions and 2 deletions
37
README.md
37
README.md
|
|
@ -1,2 +1,35 @@
|
||||||
# libcosmic
|
# LIBCOSMIC
|
||||||
WIP
|
|
||||||
|
Building blocks for COSMIC applications.
|
||||||
|
|
||||||
|
## Building
|
||||||
|
Libcosmic is written in pure Rust, so `cargo` is all you need.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
cargo build
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
There's examples in the `examples` directory.
|
||||||
|
|
||||||
|
### Widget library
|
||||||
|
```shell
|
||||||
|
cargo run --release --example cosmic
|
||||||
|
```
|
||||||
|
|
||||||
|
### Text rendering
|
||||||
|
```shell
|
||||||
|
cargo run --release --example text
|
||||||
|
```
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
The documentation can be found [here](https://pop-os.github.io/docs/).
|
||||||
|
|
||||||
|
## Licence
|
||||||
|
Libcosmic is licenced under the MPL-2.0
|
||||||
|
|
||||||
|
## Contact
|
||||||
|
- [Mattermost](https://chat.pop-os.org/)
|
||||||
|
- [Discord](https://chat.pop-os.org/)
|
||||||
|
- [Twitter](https://twitter.com/pop_os_official)
|
||||||
|
- [Instagram](https://www.instagram.com/pop_os_official/)
|
||||||
Loading…
Add table
Add a link
Reference in a new issue