Update your README.md using the template below. We are specifically interested in the installation instructions (e.g., all the gems, how to load real or seed data, etc.). This sample README was developed for a Rails project, so you can swap the "Gems" section of the "Installation" instructions to include add-ons that are relevant to you.
Make sure to check out the repo anew (potentially on a loaned laptop) and test your installation instructions.
Provide a README file with the following information:
TODO: A 20-second elevator pitch of your project - its core idea summarized in one sentence.
TODO: Write a compelling/creative/informative project description / summary
TODO: List what a user needs to have installed before running the installation instructions below (e.g., git, which versions of Ruby/Rails)
TODO: List which gems you added to the project, and the purpose each gem serves in your app.
TODO: Describe the installation process (making sure you mention bundle install).
Instructions need to be such that a user can just copy/paste the commands to get things set up and running.
TODO: Write usage instructions. Structuring it as a walkthrough can help structure this section, and showcase your features.
TODO: Describe any known issues, bugs, odd behaviors or code smells. Provide steps to reproduce the problem and/or name a file or a function where the problem lives.
TODO: Leave the steps below if you want others to contribute to your project.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request :D
If you haven't already, add a file called LICENSE.txt with the text of the appropriate license.
We recommend using the MIT license: https://choosealicense.com/licenses/mit/