upydev icon indicating copy to clipboard operation
upydev copied to clipboard

Published 20 hours ago • verified publisher icon Carglglz

Refactor Readme

Open stsdc opened this issue 5 years ago • 2 comments

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

stsdc avatar May 02 '20 12:05 stsdc

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. 👍

Carglglz avatar May 02 '20 16:05 Carglglz

PR #12 is ready for review and merge.

stsdc avatar May 03 '20 12:05 stsdc