imageproc icon indicating copy to clipboard operation
imageproc copied to clipboard

Add images to readme and/or documentation

Open theotherphil opened this issue 7 years ago • 5 comments

Show what the various functions do visually. Pretty pictures are more of a draw than text!

theotherphil avatar Jul 08 '17 16:07 theotherphil

criterion-plot uses an interesting hack - the doc generation first runs cargo test and then links to the target directory from the docs. This lets you include images in the docs, and ensures that the images match the doctests which produce them. However, it also means that just running cargo doc will produce broken docs (so docs.rs, for example, will contain a load of broken links).

theotherphil avatar Jul 13 '17 07:07 theotherphil

How would I go about modifying the docs to place example images?

Shoud I still follow the suggestion from the previous comment?

arthmis avatar Nov 10 '18 22:11 arthmis

I'm actually not sure how to add pictures to the documentation in a way that will work when rendered on docs.rs. Adding some images to the README is easier - just commit them to the repo and link to them.

theotherphil avatar Nov 13 '18 06:11 theotherphil

What should the images demonstrate about the project because I can't imagine showing an example of most of the algorithms in the readme. It would probably be too much in one place.

arthmis avatar Nov 13 '18 20:11 arthmis

Sorry for the slow replies.

I didn't have any particular plans for what to show - I was imagining just picking a few functions that produce interesting looking results and showing the outputs of those. The intention was just to add a bit of colour to the README rather than to provide an accurate overview of what is available in this crate.

theotherphil avatar Nov 16 '18 07:11 theotherphil