Skip to content

Commit

Permalink
update README to include install docs
Browse files Browse the repository at this point in the history
  • Loading branch information
xiongchiamiov committed Apr 9, 2012
1 parent cfcd377 commit 750981f
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 13 deletions.
19 changes: 10 additions & 9 deletions README.md
@@ -1,15 +1,16 @@
Screensavers are cool. Why can't you have them in your terminals?

# The Gist of It
# Install

Process runs in the background of every shell. Every command you run triggers
a hook that resets a timer. If the timer doesn't get reset in a certain amount
of time, run a program (preferably something like [CMatrix]).
1. Copy `terminal-screensaver.conf.example` to `~/.terminal-screensaver.conf`
and modify as you wish.
2. In your `~/.bashrc` or `~/.zshrc`, add a sourcing of the
`terminal-screensaver-include.sh` file:

[CMatrix]: http://www.asty.org/cmatrix/
screensaver_source=$HOME/Documents/terminal-screensaver/terminal-screensaver-include.sh
[[ -s "$screensaver_source" ]] && source "$screensaver_source"

# Status

There are a bunch of things I need to work out before this works at all.
Consider this just ideas thrown into a repo for now.
3. Put `terminal-screensaver` and `terminal-screensaver-reset` somewhere in
your `PATH`.
4. Read the comments in `terminal-screensaverd` and run it.

5 changes: 1 addition & 4 deletions terminal-screensaver-include.sh
Expand Up @@ -5,16 +5,13 @@
shell=`ps -p $$ | tail -1 | awk '{print $NF}' | sed 's/-//'`

# For development purposes only!
PATH=$PATH:.
#PATH=$PATH:.

case $shell in
"bash")
trap 'terminal-screensaver-reset' DEBUG
trap 'terminal-screensaver' SIGALRM
;;
"sh")
trap 'terminal-screensaver-reset' DEBUG
;;
"zsh")
function preexec () { terminal-screensaver-reset; }
trap 'terminal-screensaver' SIGALRM
Expand Down

0 comments on commit 750981f

Please sign in to comment.