search

JuliaImages / DitherPunk.jl

Dithering algorithms in Julia.
MIT License
68 stars 3 forks source link

Add images to readme #33

Closed adrhill closed 3 years ago

adrhill commented 3 years ago

The readme refers to the gallery in the docs but looks a bit dry. Should I add an asset-folder to /docs or just upload some images as comments here and link to them @johnnychen94?

johnnychen94 commented 3 years ago

Adding an asset folder to docs/ definitely works, there is just one small thing: Julia Pkg Server will achieve everything in the master branch and ship them to the users. So if you're planning to add like 10M files, that would be a large burden. An extreme case like this is https://github.com/tlnagy/OMETIFF.jl/issues/87

Upload images as comments here is a trick to work around this limitation. So I think it's probably a better option. But of course, need some more manual work if you plan to upload tens of images.

Another option is to have them in gh-pages branch and then use raw link here, e.g.,

the rawlink to https://github.com/JuliaImages/juliaimages.github.io/blob/master/dev/examples/color_channels/assets/indexed_image.png
![](https://raw.githubusercontent.com/JuliaImages/juliaimages.github.io/master/dev/examples/color_channels/assets/indexed_image.png)
<img src="https://raw.githubusercontent.com/JuliaImages/juliaimages.github.io/master/dev/examples/color_channels/assets/indexed_image.png" alt="bad_result.png" width="100">
bad_result.png