Skip to content

lolcommits/lolcommits-term_output

Repository files navigation

Lolcommits Term Output

Build Gem Depfu

lolcommits takes a snapshot with your webcam every time you git commit code, and archives a lolcat style image with it. Git blame has never been so much fun!

This plugin uses the inline image feature available in iTerm2 to display each lolcommit (images only) in your terminal (after committing). For example:

iterm inline sample screenshot

Requirements

Installation

After installing the lolcommits gem, install this plugin with:

$ gem install lolcommits-term_output

Then configure to enable and set the remote endpoint:

$ lolcommits --config -p term_output
# set enabled to `true`

That's it! Your next lolcommit will be displayed within your terminal. To disable use:

$ lolcommits --config -p term_output
# and set enabled to `false`

Development

Check out this repo and run bin/setup, this will install all dependencies and generate docs. Use bundle exec rake to run all tests.

You can also run bin/console for an interactive prompt that will allow you to experiment with the gem code.

Tests

MiniTest is used for testing. Run the test suite with:

$ rake test

Docs

Generate docs for this gem with:

$ rake rdoc

Troubles?

If you think something is broken or missing, please raise a new issue. Take a moment to check it hasn't been raised in the past (and possibly closed).

Contributing

Bug reports and pull requests are welcome on GitHub.

When submitting pull requests, remember to add tests covering any new behaviour, and ensure all tests are passing on CI. Read the contributing guidelines for more details.

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct. See here for more details.

License

The gem is available as open source under the terms of LGPL-3.

Links