aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormat <github@matdoes.dev>2022-11-11 21:55:47 -0600
committermat <github@matdoes.dev>2022-11-11 21:55:47 -0600
commite6db7d5f2ffa88e95965a421b13e54b83aaef175 (patch)
treeca03d9907fea02d443cf6ce2ec3216e8f4ef53c6
parent3530faea4e5e7e2b4b4ce31073219e615057cf33 (diff)
downloadazalea-drasl-e6db7d5f2ffa88e95965a421b13e54b83aaef175.tar.xz
add optimization stuff to azalea docs
-rw-r--r--azalea/src/lib.rs16
1 files changed, 15 insertions, 1 deletions
diff --git a/azalea/src/lib.rs b/azalea/src/lib.rs
index b2d54d63..8287ea1b 100644
--- a/azalea/src/lib.rs
+++ b/azalea/src/lib.rs
@@ -11,12 +11,26 @@
//! default nightly`.
//!
//! Then, add one of the following lines to your Cargo.toml:
-//!
+//!
//! Latest bleeding-edge version:
//! `azalea = { git="https://github.com/mat-1/Cargo.toml" }`\
//! Latest "stable" release:
//! `azalea = "0.3"`
//!
+//! # Optimization
+//!
+//! For faster compile times, make a .cargo/config.toml file in your project
+//! and copy
+//! [this file](https://github.com/mat-1/azalea/blob/main/.cargo/config.toml)
+//! into it.
+//!
+//! For faster performance in debug mode, add
+//! ```toml
+//! [profile.dev.package.*]
+//! opt-level = 3
+//! ```
+//! to your Cargo.toml.
+//!
//! # Examples
//!
//! ```rust,no_run