joukos / PaperTTY

PaperTTY - Python module to render a TTY or VNC on e-ink
946 stars 101 forks source link

Clean up and organize README #43

Open joukos opened 4 years ago

joukos commented 4 years ago

The main README is too long. There's old but valid documentation way too far to be comfortably scrolled to because of meandering hit-and-run updates and not having the time to keep the docs concise and updated.

Some stuff to do:

This would be easiest for me to do, but since it's so hard to get a proper moment to do it, I've created this issue to nag me. And if I never get around to it, maybe someone else with a knack for documentation will :)

chi-lambda commented 4 years ago

Github has a wiki feature. Would that be a better format?

joukos commented 4 years ago

In some other old project I used the Wiki, but the problem is that no one looks there :) If there's a whole library of information, it might be useful, but I think in this case it would be more effective to clean up the main README.