Your Open Source Project Name
Describe what does this project does in one line followed by your project logo if you have one. e.g.
A project skeleton for open source projects at Power.
Please keep this short. Copy it to the GitHub’s project description.
An optional Elevator Pitch of the project.
Example
Do you have some awesome code you want to release to the world on GitHub? If so, this repo provides all the files you’ll need to prepare your project for public release on GitHub.com. It’s a reference implementation of the Power Open Source Skeleton Specification, follow the requirements of this specification when adapting the content of this repo to your own project.
You can add optional badges such as those on http://shields.io here.
Table of Contents
Background
Describe why this project exists in more detail than the elevator pitch. Don’t include code examples or other in-depth material. Someone who is familiar with the project should be able to refresh their memory without hitting “page down”. As your reader continues through the document, they should receive a progressively greater amount of detail. Answer questions like: The motivation for creating this project. How this project differs from others. Who is this for. What else do readers ned to know to understand this project.
Example
We want to make it very easy for employees who publish code to attract positive attention to their work. Some porjects are very complex, so we created an outline to help. This helps publishers gather the information in an organized way. This also helps those who browse our projects get the information they need to decide if this project is relevant to them, and if so, how to proceed. We ask employees who publish new open source projects to adapt these files to meet the needs of your project based on the Power Open Source Skeleton Specification.
Install
Describe how to install and use this project. Readers may be novices, but our tone is informative, not condescending. You can point to instructions rather than writing too much here. Remember, if users can’t install this project, they will not contribute much to it. Assume they might need information about the programming language version or operating environment information. Don’t assume they operate under the same exact conditions we do internally.
Example
If you’ve never used git before, please take a moment to familiarize yourself with what it is and how it works. To install this project, you’ll need to have git installed and set up on your local dev environment.
Install by running the following command.
git clone <link>
This will create a directory called Power-Open-Source-Skeleton and download the contents of this repo to it.
Configuration
Describe any configurations the user will need to complete to run this project.
Example
This project doesn’t have any configuration concerns. This is a placeholder in case users of this project need to be made aware of anything related to host setup, environment variable configuration, or just about anything worth making clear and upfront. If you don’t need it, delete this section and the reference to it in the table of contents.
Usage
Describe what you expect people to do once they install this project. Add code blocks if relevant.
Example
After installing this repo, change the content of this README to meet your specific project, then copy all files located inside this repo to your project directory, like so:
cp README.md ~/your/project/directory/
Security
This project doesn’t have any security concerns. This is a placeholder in case users of this project need to be made aware of anything related to authentication, privacy, cryptography, root access, or just about anything worth making clear and upfront. If you don’t need it, delete this section and the reference to it in the table of contents.
API
This project doesn’t have an API. This is a placeholder in case you need it for your project. If you don’t need it, delete this section and the reference to it in the table of contents.
More optional sections
If you need more sections, add them here and reference them in the table of contents. You might add a section describing future features or known issues.
Contribute
Please refer to the contributing.md file for information about how to get involved. We welcome issues, questions, and pull requests.
Maintainers
- Joe Bloggs: joe.bloggs@powerhrg.com
License
State license full name or SPDX identifier.
Examples (select or modify as appropriate)
- This project is licensed under the terms of the MIT open source license. Please refer to LICENSE for the full terms.
- This project is licensed under the terms of the Apache 2.0 open source license. Please refer to LICENSE for the full terms.