javaee7-samples icon indicating copy to clipboard operation
javaee7-samples copied to clipboard

Published 20 hours ago • verified publisher icon javaee-samples

Move main README to Wiki

Open bartoszmajsak opened this issue 10 years ago • 3 comments

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.

bartoszmajsak avatar May 03 '14 20:05 bartoszmajsak

Yep, sounds like a great idea.

Lets keep README simple.

arun-gupta avatar May 05 '14 16:05 arun-gupta

Add a CONTRIBUTING file to root that points to wiki

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

aslakknutsen avatar May 05 '14 17:05 aslakknutsen

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

bartoszmajsak avatar May 05 '14 18:05 bartoszmajsak