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

Create README and LICENSE file #1

Open
lehnerpat opened this issue Jul 14, 2014 · 0 comments
Open

Create README and LICENSE file #1

lehnerpat opened this issue Jul 14, 2014 · 0 comments

Comments

@lehnerpat
Copy link
Collaborator

Projects on GitHub usually have a README (or README.md for markdown format) file in their root folder, which serves as an entry-point for people wanting to learn about the project.

It should summarize the goal and state of the project, and in this particular case, refer to the doc folder for more technical information.

There should also be a LICENSE file (I like to go with BSD licenses as they are very permissive, but GPL is another general-purpose alternative; see http://choosealicense.com/ for a nice summary) with the full license terms; a short summary of the license should be included in the README file and all source files.

Additionally, if you move or copy the doc/HowToContribute.txt file to CONTRIBUTING (in the root folder), GitHub will show a link to it when users create a new Pull Request.

Edit: When including 3rd party libs, you should make sure their license terms are also included, preferrably as a LICENSE file in the lib's main folder.

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