Add note to README about optional features.

greatscottgadgets · Jun 26, 2024 · 74d9653 · 74d9653
1 parent 72ef2d3
commit 74d9653
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -20,6 +20,8 @@ To build, run `cargo build` after installing the necessary prerequisites (see be
 
 If you pass a capture filename as an argument, Packetry will attempt to load it. The current supported file format is a `.pcap` file with the `LINKTYPE_USB_2_0` link layer header type.
 
+Note: Do not build with `--all-features`. All the optional features currently in the package are for debug/test purposes only, and will prevent or degrade normal use of the application if enabled. See `Cargo.toml` for details.
+
 ### Installing prerequisites
 
 #### Linux