README: Include more information, new screenshot #867
Conversation
Add more sections, with more links, small install guide, add new screenshot. This should make the README more inviting to people browsing GH - and also PyPI, as the README is also automatically uploaded there.
ix5
added
docs
| ## Geting started | ||
|
|
||
| **Requirements** | ||
| - Python 3.6+ (+ devel headers) |
There was a problem hiding this comment.
Why do we need devel headers or a C compiler? @ix5
There was a problem hiding this comment.
This was a copy-paste from the docs. Probably necessary for misaka and CFFI things?
There was a problem hiding this comment.
It looks like you were also the one who added it to the docs in 93d05c4
I don't think we need C headers for something that's CFFI.
There was a problem hiding this comment.
Devel headers were added way back in d1a0b3f6, I just happen to show up in the blame logs because I bumped versions a couple of times and moved files ;)
As for the validity, maybe we ought to collect empirical data by removing devel headers from our respective systems and seeing whether a full installation in a clean virtualenv (including misaka CFFI compilation) still works.
| ## Geting started | ||
|
|
||
| **Requirements** | ||
| - Python 3.6+ (+ devel headers) |
There was a problem hiding this comment.
It looks like you were also the one who added it to the docs in 93d05c4
I don't think we need C headers for something that's CFFI.
|
|
||
| **Requirements** | ||
| - Python 3.6+ (+ devel headers) | ||
| - SQLite 3.3.8 or later |
There was a problem hiding this comment.
SQLite3 is bundled with python, isn't it? You don't really need the command-line tool.
There was a problem hiding this comment.
Same as for the devel headers, let's verify and then I'm not at all opposed to removing those docs lines.
Add more sections, with more links, small install guide, add new screenshot.
This should make the README more inviting to people browsing GH - and also PyPI, as the README is also automatically uploaded there.
Live preview @ TestPyPI
Screenshot used:
