Sample README.md

projectName

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.

Description

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

Installation

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.

Usage Instructions

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

Future

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

Contribution

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.

Licensing

PLACE A COPY OF THE APACHE LICENSE FILE IN YOUR PROJECT

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Support

Please file bugs and issues at the Github issues page. For more general discussions you can contact the EMC Code team at Google Groups or tagged with EMC on Stackoverflow.com. The code and documentation are released with no warranties or SLAs and are intended to be supported through a community driven process.