-
Notifications
You must be signed in to change notification settings - Fork 18
Sample README.md
projectName abstract. 1-2 sentences on what this actually does. Remember that all README.md files are required to be done in markdown format. Download a sample README.md to place in your project.
a description of the projectName more in depth. this can be 2-5 sentences and could also contain bullet points for use cases. Such as:
- use case 1
- use case 2
- sub use case A
- sub use case B
- use case 3
How do install your software to make it work? Do i just download the scripts? Do i download them from a central repository. This section should give readers a spoon-fed way of understanding how do i get to step 1. Make sure you recognize multiple deployment scenarios as well if it it integrates with things like Vagrant or Docker.
This is where you lay out all the commands available or how you make your software do its magic. This can be CLI, REST, powershell commands, etc. Remember to use the backtick characters to highlight code such as this or create sections of code using three backticks in a row
to do
multiline
code
this is where you can add things you plan on adding to the future. this helps anyone wanting to contribute to know what they can help with. This is not a necessary thing to do if your project doesn't have a roadmap.
- Add these functions depending on necessity
- thing 1
- thing 2
- thing 3
- Clean up the code
- break out into multiple files
- etc
Create a fork of the project into your own reposity. Make all your necessary changes and create a pull request with a description on what was added or removed and details explaining the changes in lines of code. If approved, project owners will merge it.
{code} does not provide legal guidance on which open source license should be used in projects. We do expect that all projects and contributions will have a valid open source license within the repo/project, or align to the appropriate license for the project/contribution. The default license used for {code} Projects is the MIT License.
Your Project Name is freely distributed under the MIT License. See LICENSE for details.
Please file bugs and issues on the Github issues page for this project. This is to help keep track and document everything related to this repo. For general discussions and further support you can join the {code} Community slack channel. Lastly, for questions asked on Stackoverflow.com please tag them with EMC. The code and documentation are released with no warranties or SLAs and are intended to be supported through a community driven process.