Front page readme.md bloat

Question

Front page readme.md bloat

olife373 opened this issue 8 years ago · 9 comments

Hey the front page readme.md is really bloated we have a WIKI section i've been working hard to integrate it would be helpfull to start moving stuff over to the WIKI page. Perhaps even have some assistance in developing it further.

Answer 1 · 2016-08-14T07:07:54.000Z

Great work on fleshing out the wiki! I hadn't looked in there at all before now.

I agree the current README.md is a bit cumbersome. It should still have the essentials for getting up and running, but I think the verbose config details may be better suited for the wiki and/or stuck in a different .md file. (I'm a huge fan of keeping all the documentation bundled with the repo so it's truly portable.)

Answer 2 · 2016-08-14T16:41:21.000Z

Agreed, the readme has gotten far too bloated, that is for sure. Thanks for fleshing out the wiki 😄

Answer 3 · 2016-08-15T15:54:12.000Z

J-e-k how do I go about getting permission to commit to the wiki?

Answer 4 · 2016-08-15T17:26:24.000Z

Let me see....

Answer 5 · 2016-08-15T17:27:31.000Z

I don't see an option other than marking you as a contributor, do you know of a way?

Answer 6 · 2016-08-15T17:48:56.000Z

Perhaps I need to fork the wiki then post commits. Sorry Im new to get hub so I believe that may be the only way. However I do intend on heavily developing the wiki.

Answer 7 · 2016-08-15T17:56:07.000Z

So after some additional research that too is not possible will continue to look into this after I'm off work.

Answer 8 · 2016-08-16T01:00:58.000Z

I'm confused… aren't you already contributing to the wiki? Or do you mean you want to change the README?

If the latter, yeah, your best route it to fork the repo and submit your changes to the README through pull requests.

Answer 9 · 2016-08-16T16:41:00.000Z

Sorry for the confusion apparently there is no easy way to edit the wiki locally and push changes or even submit pull requests. @infinitewarp