git-directory-deploy icon indicating copy to clipboard operation
git-directory-deploy copied to clipboard

Published 20 hours ago • verified publisher icon X1011

refactor readme

Open X1011 opened this issue 9 years ago • 1 comments

i think the readme needs some refactoring now. It doesn't make sense anymore to instruct users to edit the variables in the script itself, especially considering how deeply buried those default values have gotten with the recent changes.

i'm thinking we merge the configuration and options sections, and the run section can be simplified, or maybe even mixed somewhere in with the rest, too.

overall, it should be more like a man page now that the script is more like a full-fledged command-line utility.

i hopefully will be able to tackle this in the next couple of days, but you, of course, are welcome to take a shot, too, @matro (or anyone else who happens to be lurking here).

X1011 avatar Dec 18 '15 10:12 X1011

I did a quick shuffle of the existing content on my "readme-refactor" branch. Not sure how I feel about it yet.

matro avatar Dec 20 '15 23:12 matro