Skip to content

Instantly share code, notes, and snippets.

@palimadra
Last active August 29, 2015 14:22
Show Gist options
  • Save palimadra/f58100e42f87027bd9d5 to your computer and use it in GitHub Desktop.
Save palimadra/f58100e42f87027bd9d5 to your computer and use it in GitHub Desktop.
Readme file in markdown for projects and folders
# Project Name
TODO: Write a project description
## Installation
TODO: Describe the installation process
## Usage
TODO: Write usage instructions
## Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D
## History
TODO: Write history
## Credits
TODO: Write credits
## License
TODO: Write license
<snippet>
<content><![CDATA[
# ${1:Project Name}
TODO: Write a project description
## Installation
TODO: Describe the installation process
## Usage
TODO: Write usage instructions
## Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D
## History
TODO: Write history
## Credits
TODO: Write credits
## License
TODO: Write license
## Contributing
Fork the project, commit your changes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment