Documentation enhancement suggestions for beginners #67
Description
I have a suggestion to make the installation documentation clearer.
The README mentions that additional features can be installed using the --features flag. Currently, the kmer-counters feature is available, and the documentation explains the general syntax: --features "feature1,feature2".
However, it took me some trial to figure out the exact command:
cargo install --path crates/cmdline/ --locked --features "kmer-counters"
This command works perfectly (the kmer counter functions well for k<64, see my other issue for details). Interestingly, the build process shows the same number of dependencies (293) with or without this flag, though the feature is indeed enabled.
Suggestion:
Since Rust tooling can be challenging for bioinformatics researchers who may not be deeply familiar with Cargo, it would be helpful to include the complete installation command as a concrete example in the README. Something like:
Standard installation
cargo install --path crates/cmdline/ --locked
Installation with kmer-counters feature
cargo install --path crates/cmdline/ --locked --features "kmer-counters"
This would make it much more accessible, especially for users new to Rust or coming from biology backgrounds.
Thanks for considering this!
Best,
Bastien