argmin-rs / argmin

Numerical optimization in pure Rust
http://argmin-rs.org
Apache License 2.0
972 stars 76 forks source link

Missing proper documentation on how to run examples #378

Closed stefan-k closed 7 months ago

stefan-k commented 8 months ago

I just noticed that there isn't an adequate documentation on how to run the examples. The only place where examples are mentioned is here. It doesn't mention that each example has its own set of required features, and the sentence "Make sure to choose the tag matching the argmin version you are using" is confusing, because it doesn't clarify that git tags are meant. This is an unnecessary entry hurdle. There should be a clear description on what one needs to do to run an example. This somewhat depends on #307.