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.

Sign up for GitHub

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

Jump to bottom

Move main README to Wiki #216

Open
bartoszmajsak opened this issue May 3, 2014 · 3 comments
Open

Move main README to Wiki #216

bartoszmajsak opened this issue May 3, 2014 · 3 comments
Assignees
@bartoszmajsak
Labels
documentation

Comments

@bartoszmajsak
Copy link
Contributor

I think README should be brief entry point to anyone who just come across our repository. It should simply describe what it is and how to run it.

Details such as how to contribute and related guidelines as well as build options could be moved to GitHub wiki.

If you think it is a good idea I can do this.
@arun-gupta
Copy link
Contributor

Yep, sounds like a great idea.

Lets keep README simple.

@aslakknutsen
Copy link
Member

Add a CONTRIBUTING file to root that points to wiki

https://github.com/blog/1184-contributing-guidelines

@bartoszmajsak
Copy link
Contributor Author

Good point, thanks @aslakknutsen. Keen to create one? :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bartoszmajsak bartoszmajsak

Labels
documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@arun-gupta @aslakknutsen @bartoszmajsak