- Create a new project.
- Copy these files into the new project.
- Update the README, replacing the contents below as prescribed.
- Add any libraries, assets, or hard dependencies whose source code will be included in the project's repository to the Exceptions section in the TERMS.
- If no exceptions are needed, remove that section from TERMS.
- Delete these instructions and everything up to the Project Title from the README.
- Write some great software and tell people about it.
Keep the README fresh! It's the first thing people see and will make the initial impression.
Description: Put a meaningful, short, plain-language description of what this project is trying to accomplish and why it matters.
Other things to include:
- Status: Alpha, Beta, 1.1, etc. It's OK to write a sentence, too. The goal is to let interested people know where this project is at. This is also a good place to link to the CHANGELOG.
- Links to production or demo instances
- Describe what sets this apart from related-projects. Linking to another doc or page is OK if this can't be expressed in a sentence or two.
Screenshot: If the software has visual components, place a screenshot after the description; e.g.,
Detailed instructions on how to install, configure, and get the project running. This should be frequently tested to ensure reliability. Alternatively, a link to another page is fine, but it's important that this works.
This section should detail why people should get involved and describe key areas you are currently focusing on; e.g., trying to get feedback on features, fixing certain bugs, building important pieces, etc.
General instructions on how to contribute should be stated with a link to CONTRIBUTING.
- Projects that inspired you
- Related projects
- Books, papers, talks, or other sources that have meaniginful impact or influence on this project