Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
s-p-k committed Apr 6, 2015
1 parent d24aa0c commit 29b92b1
Showing 1 changed file with 4 additions and 15 deletions.
19 changes: 4 additions & 15 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,10 @@ peek uses by default your $EDITOR variable to edit your cheatsheets. If $EDITOR
is not set, it uses /usr/bin/vi.

So just set your $EDITOR variable. Since the directory that the cheatsheets are
saved is ~/.peek , you have to create it if it doesn't exist. If you want a
different directory to save your cheatsheets, edit peek.c according to your
needs.
saved is ~/.peek/ , you have to create it and edit config.h to point to it. If
you want a different directory to save your cheatsheets, edit config.h according
to your needs. After making the changes to your config.h continue to installing
peek.

--------------------------------------------------------------------------------
Installing peek
Expand Down Expand Up @@ -42,15 +43,3 @@ You can get a sample of cheatheets here:
https://github.com/s-p-k/cheatsheets

Just copy them on your ~/.peek/ directory.

--------------------------------------------------------------------------------
Screenshots
--------------------------------------------------------------------------------

Listing available cheatsheets in ~/.peek/:

https://github.com/s-p-k/peek/blob/master/list-cs.png

Supposing i want to read the 'git' cheatsheet:

https://github.com/s-p-k/peek/blob/master/peek-readcs.png

0 comments on commit 29b92b1

Please sign in to comment.