Mirrors/catppuccin-palette
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs: use crate version in doc comment, add example outputs

Browse source
This commit is contained in:
backwardspy 2022-10-23 20:09:58 +01:00
parent 6d8a72071d
commit 0c9955f05e
5 changed files with 19 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -87,7 +87,7 @@ Add the crate to your `Cargo.toml`:
cargo add catppuccin cargo add catppuccin
``` ```
More information and examples can be found on [crates.io](https://crates.io/crates/catppuccin), [docs.rs](https://docs.rs/catppuccin/1.0.2/catppuccin/), More information and examples can be found on [crates.io](https://crates.io/crates/catppuccin), [docs.rs](https://docs.rs/catppuccin/latest/catppuccin/),
and in the [`rust`](https://github.com/catppuccin/palette/tree/main/rust) folder. and in the [`rust`](https://github.com/catppuccin/palette/tree/main/rust) folder.
### Affinity ### Affinity

11
rust/README.md
View file

@ -8,7 +8,7 @@ Add Catppuccin to your project's `Cargo.toml`:
```toml ```toml
[dependencies] [dependencies]
catppuccin = "1.0.0" catppuccin = "1.0.2"
``` ```
## Example ## Example
@ -34,11 +34,18 @@ More examples can be found
Clone the repository to run them locally: Clone the repository to run them locally:
```shell ```bash
$ cargo run --example simple $ cargo run --example simple
```
![Output from simple example](https://raw.githubusercontent.com/catppuccin/palette/main/rust/assets/simple-example.png)
```bash
$ cargo run --features ansi --example term $ cargo run --features ansi --example term
``` ```
![Output from term example](https://raw.githubusercontent.com/catppuccin/palette/main/rust/assets/term-example.png)
## Optional Features ## Optional Features
### ANSI string painting ### ANSI string painting

BIN
rust/assets/simple-example.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 34 KiB

BIN
rust/assets/term-example.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 27 KiB

11
rust/src/lib.rs
View file

@ -6,7 +6,7 @@
//! //!
//! ```toml //! ```toml
//! [dependencies] //! [dependencies]
//! catppuccin = "1.0.0" #![doc = concat!("catppuccin = \"", env!("CARGO_PKG_VERSION"), "\"")]
//! ``` //! ```
//! //!
//! # Example //! # Example
@ -32,11 +32,18 @@
//! //!
//! Clone the repository to run them locally: //! Clone the repository to run them locally:
//! //!
//! ```shell //! ```bash
//! $ cargo run --example simple //! $ cargo run --example simple
//! ```
//!
//! ![Output from simple example](https://raw.githubusercontent.com/catppuccin/palette/main/rust/assets/simple-example.png)
//!
//! ```bash
//! $ cargo run --features ansi --example term //! $ cargo run --features ansi --example term
//! ``` //! ```
//! //!
//! ![Output from term example](https://raw.githubusercontent.com/catppuccin/palette/main/rust/assets/term-example.png)
//!
//! # Optional Features //! # Optional Features
//! //!
//! ## ANSI string painting //! ## ANSI string painting