search

Davejkane / riv

Riv - The Rust Image Viewer
MIT License
99 stars 10 forks source link

New improved README #60

Open Davejkane opened 5 years ago

Davejkane commented 5 years ago

Change the README to be user focused instead of a call to green developers (I'm happy with the little team that we have, any more at this stage would just be too much getting in each others way).

gurgalex commented 5 years ago

Remove calls for developer participation

I liked the contributing section. Seemed welcoming to me despite having no prior experience with SDL2 or image viewers. Maybe removing the sentence

I have purposely left some features unimplemented before open sourcing with the idea that someone can pick them up as a good first contribution

Davejkane commented 5 years ago

Yeah, ok. I'll leave some of the contributing section there, and maybe move the rest to the CONTRIBUTING.md

NickHackman commented 5 years ago

If we're moving towards a more user facing perspective we should have a man page in addition to the readme

Davejkane commented 5 years ago

@NickHackman, agreed, but we'll wait with that until we're ready to look at platform specific build scripts. And that's not just yet.

Unless this works... https://github.com/clap-rs/clap_generate

gurgalex commented 5 years ago

So, we could have riv view the rust logos for the screenshot. It is the Rust Image Viewer riv_rust_logo

Davejkane commented 5 years ago

Yeah, was thinking something similar

gurgalex commented 5 years ago

Though, we really need to make it clear that riv is a minimal GUI image viewer and does not render to the terminal.

gurgalex commented 5 years ago

So, the animated gif should probably give a quick demonstration of the important features correct?

Similar to this interactive Postgres prompt