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

Document configurations more #137

Open
wookayin opened this issue Feb 8, 2014 · 0 comments
Open

Document configurations more #137

wookayin opened this issue Feb 8, 2014 · 0 comments

Comments

@wookayin
Copy link
Collaborator

wookayin commented Feb 8, 2014

Let's improve the documentations.

The wiki pages Basic Usage and Full configuration are the place for the configuration documentation, and it provides most of configurable things.

But since users may be confused on the syntax, or might want to see the live examples.
Users are encouraged to see default.conf, but there are few comments on it. It would be great if we provide a little explanation on each field -- documentation as a code (but detailed explanation in wiki).

Moreover, it'd be also great to add some common-case examples of greed.conf into the Basic Usage wiki page.

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

1 participant