This README would normally document whatever steps are necessary to get the application up and running.
- Fork the repo
- Clone the repo "git clone https://github.com/your-username/original-repo-name.git"
- switch to the repo directory "cd original-repo-name"
- List cirrent remotes "git remote -v"
- Add an Upstream Remote - Reference to the origin al repo as the upstream remote "git remote add upstream https://github.com/original-author/original-repo-name.git"
- Fetch from 'Upstream' - "git fetch upstream"
Things you may want to cover:
-
Ruby version
-
System dependencies
-
Configuration
-
Database creation
-
Database initialization
-
How to run the test suite
-
Services (job queues, cache servers, search engines, etc.)
-
Deployment instructions
-
...