Cheatly
This is a command line toolset to handle the cheat-sheets repository located at sheets folder.
This gem is not a fork but inspired by defunkt/cheat. However instead of using a full server to store the sheets, it uses github as central repository, making more reliable and easy to add new ones.
Help: Adding a new cheat-sheet
Submit a PR, adding a file to sheets
folder, with the cheat-sheet name.
git clone https://github.com/arthurnn/cheatly.git && cd cheatly
-
cheatly create name
(replacing name with name of the sheet) - Replace content of
sheets/name.md
-
cheatly show --local NAME
to test your new sheet - Create new Pull Request
Installation
$ gem install cheatly
Usage
Help
$ cheatly help
List all cheat sheets
$ cheatly ls
Show a cheat sheet
$ cheatly show gem_release
Contributing
- 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
) - Create new Pull Request
Build from source
Building from source will allow you to test changes to your code locally before pushing it back to origin.
git clone https://github.com/arthurnn/cheatly.git
cd cheatly
bundle exec rake install
Repeat steps 3-4 to check modified code.
Testing
You can also run tests using rake test
command.