Skip to content

jpotts18/readme-generator

Repository files navigation

Readme Generator

The best way to generate the documentation your boss always wanted and you hesitated to write.

System Dependencies

  • Ruby 2.0+

Getting Started

  1. Clone the Repo git clone [this repo]
  2. Open up editor ruby readme.rb
  3. Follow the prompt and enjoy!

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. Create a new Pull Request

About

Generate the documentation your boss always wanted

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages