search

Carglglz / upydev

Command line tool for MicroPython devices
https://pypi.org/project/upydev/
MIT License
57 stars 9 forks source link

Refactor Readme #7

Open stsdc opened 4 years ago

stsdc commented 4 years ago

First of all: this tool is amazing! Thank You! But the readme file is huge, it is hard to find how to do basic things. IMHO: Readme should be decluttered and must include most basic things, other specific options and functions should be on gitbook or wiki.

If You're ok with this, I'll try to make a PR. Thanks again for this utility and please continue <3

Carglglz commented 4 years ago

But the readme file is huge, it is hard to find how to do basic things.

Yes, I'm aware.

The README just kept on growing as the project did, but now I do belive a refactor is necessary, as well as some sort of "wiki" or the "read the docs". I made a gitbook so feel free to make contributions both in the README in this repo as well as in the gitbook. 👍

stsdc commented 4 years ago

PR #12 is ready for review and merge.