Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor readme #24

Open
X1011 opened this issue Dec 18, 2015 · 1 comment
Open

refactor readme #24

X1011 opened this issue Dec 18, 2015 · 1 comment

Comments

@X1011
Copy link
Owner

X1011 commented Dec 18, 2015

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

@matro
Copy link
Contributor

matro commented Dec 20, 2015

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants