Possible readme rewrite?

QuinterApp / Quinter

The accessible Quinter Twitter client

11 stars 9 forks source link

Possible readme rewrite? #16

Closed TheQuinbox closed 3 years ago

TheQuinbox commented 3 years ago

As this would be a pretty big change to how the users see the docs, I figured I'd open an issue first. I was considering rewriting the docs in Markdown and converting to nicely readable HTML with Pandoc. This would

Give us a table of contents
Make users able to jump to different sections by heading level.
Keep the readme in an easy-to-understand format. Thoughts?

masonasons commented 3 years ago

If you want to do it, bee my guest.

TheQuinbox commented 3 years ago

OK, sweet.