colindean/fillertext

Add instructions to README for contribution

Ashvith10 opened this issue · 1 comments

Ashvith10 commented

This can be simply included in the README.md file. Here are some starter ideas I have come up with, which could be included.

  • How to start with the project?: Fork the project and run bundle install to install all the required dependencies
  • How to install the gem: Run gem install fillertext
  • How to test the project?: Simply run rspec. To run a specific test, run rspec spec/<test_you're_interested_in>_spec.rb
  • How to access code coverage details: First run rspec, then xdg-open coverage/index.html (Linux) or open coverage/index.html (Mac)
colindean commented

I'd welcome a PR that includes these in the README!