breily / cheat

cheat - command line access to oft forgotten syntax/apis/arguments
==================================================================

    ] by:   brian reily
    ] url:  brianreily.com/projects/cheat/
    ] url:  github.com/breily/cheat/tree/master/

description
-----------

    ] i created cheat because man pages are great for learning
      about things but horrible for quick reference.  If you need
      to remember a custom flag for gcc, you have to search through
      the huge man page for it, or use cheat and make a gcc cheatsheet
      that references that one command.
    
    ] cheat also lets you easily add your own sheets for stuff that
      doesn't go in man pages.
    
    ] why not just use http://cheat.errtheblog.com?  first, i didn't know
      it existed when I wrote the first version of this.  second, that
      cheat only lets you use one name for each sheet - the filename.  my
      cheat allows multiple search terms for each sheet.

install
-------

    ] if you don't want cheat installed in /usr/bin/cheat,
      change BIN_DIR in setup.rb

    ] run 'sudo ruby setup.rb'

    ] run 'cheat' to make sure everything worked

editing cheat.py or adding sheets
---------------------------------

    ] run 'sudo ruby setup.rb', this will recopy all cheat sheets, as well as
      cheat.py.  Existing files will be overwritten, so be careful.

commands
--------

    ] 'cheat -h|--help'                  <- Show help information.

    ] 'cheat -l|--list [ -v|--verbose ]' <- List all available cheat sheets.

    ] 'cheat -e|--edit sheet'            <- Edit a cheat sheet.

    ] 'cheat sheet'                      <- View a cheat sheet.

cheatsheets
-----------

    ] a description of how to make cheatsheets is displayed
      by running 'cheat'

    ] also, see included examples

    ] the filename does not matter, only the terms list in the file

    ] if you want cheatsheets someplace besides ~/.cheat,
      change CHEAT_DIR in setup.rb.  also change or add to
      CHEAT_DIRS in cheat.py.

    ] if you have a good cheat sheet, let me know so i can add it to the
      repository
 
notes
-----

    ] i won't be added any features to cheat anytime soon, mainly just
      adding sheets as i need them