Skip to content

Commit

Permalink
Expand caveats
Browse files Browse the repository at this point in the history
  • Loading branch information
Kobzol committed Mar 9, 2024
1 parent b913751 commit 2951874
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,13 @@ set of prepared templates:

You can also modify these templates in the interactive mode to build your own custom template.

## Comments
## Caveats

- The configuration applied by this tool is quite opinionated and might not fit all use-cases
perfectly. `cargo-wizard` mostly serves to improve *discoverability* of possible Cargo profile and config options, to
help you find the ideal settings for your use-cases.
- `cargo-wizard` currently only modifies `Cargo.toml` and `config.toml`. There are other things that can be configured
to achieve e.g. even smaller binaries, but these are out of scope for this tool, at least at the moment.
- `cargo-wizard` currently ignores Cargo settings that are not relevant to performance.
- Cargo config (`config.toml`) changes are applied to the global `build.hostflags` setting, because per-profile
RUSTFLAGS are still [unstable](https://github.com/rust-lang/cargo/issues/10271).
Expand Down

0 comments on commit 2951874

Please sign in to comment.