mat/azalea
1
2
Fork 0
mirror of https://github.com/mat-1/azalea.git synced 2025-08-02 06:16:04 +00:00
Code Issues Projects Releases Packages Activity

don't reference version number directly in docs

Browse source
This commit is contained in:
mat 2023-12-05 11:24:01 -06:00
parent c5b15c0293
commit 1369848c82
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
azalea/README.md
View file

@ -7,10 +7,10 @@ See the [readme](https://github.com/azalea-rs/azalea) for a higher-level overvie
First, install Rust nightly with `rustup install nightly` and `rustup default nightly`.
Then, add one of the following lines to your Cargo.toml:
Then, use one of the following commands to add Azalea to your project:
- Latest bleeding-edge version (recommended): `azalea = { git="https://github.com/azalea-rs/azalea" }`\
- Latest "stable" release: `azalea = "0.8.0"`
- Latest bleeding-edge version (recommended): `cargo add azalea --git=https://github.com/azalea-rs/azalea`\
- Latest "stable" release: `cargo add azalea`
## Optimization
@ -21,12 +21,14 @@ into it. You may have to install the LLD linker.
For faster performance in debug mode, add the following code to your
Cargo.toml:
```toml
[profile.dev]
opt-level = 1
[profile.dev.package."*"]
opt-level = 3
```
# Documentation
The documentation for the latest Azalea crates.io release is available at [docs.rs/azalea](https://docs.rs/azalea/latest/azalea/) and the docs for the latest bleeding-edge (git) version are at [azalea.matdoes.dev](https://azalea.matdoes.dev/azalea/).
@ -35,7 +37,6 @@ Note that the `azalea` crate is technically just a wrapper over [`azalea_client`
Because of this, some of the documentation will refer to `azalea_client`.
You can just replace these with `azalea` in your code since everything from `azalea_client` is re-exported in azalea.
# Examples
```rust,no_run