Update README (as of v0.0.5)
Closed this issue · 2 comments
lsrdg commented
The upcoming v0.0.5 release is an important milestone to the project and the
README needs to be improved.
The README needs to be more concise about:
- what the project does (and what it doesn't),
- what are the short and long time goals,
- where is the development happening (#18 )
Try to be a bit more clear about the commands. Find a better way to present the
features.
The README will still be the "docs"
(v0.0.6 will be shiped
with a better documentation). Despite of that, the "how to"/"getting started"
needs to be improved.
The commands can be divided into three groups:
-
- those depending on internet connections
- (
-b) open the browser searching for a term in/to the given languages - (
-i) like-bbut searching by sentence's id - (
-r) request/scrap the website
- (
- those depending on internet connections
-
- those that perform locally
- (
f) find sentence, in a given language, containing term in the target
language - (
s) like-f, plus finds translations to the found sentence
- (
- those that perform locally
-
- helpers (to provide a better (group(s) 1 and/or 2)
- (
-d) download and uncompress files - (
-l) given a language, return its abbreviation
- (
- helpers (to provide a better (group(s) 1 and/or 2)
Points to be reviewed:
- README's structure
- Requirements
- Getting started
- Current stage X Notes
- TODO becomes something else (roadmap, maybe?)
- Acknowledge contributions
- Actually add a license to the code (creative content's license is noted)