Skip to content

Commit

Permalink
Add installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
kljensen committed May 21, 2013
1 parent b12291c commit 5bf606c
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Shell interval training timer
=============================


A small shell script for doing [interval training](http://en.wikipedia.org/wiki/Interval_training)
A [small shell script](https://github.com/kljensen/shell-interval-training-timer/blob/master/workout.sh) for doing [interval training](http://en.wikipedia.org/wiki/Interval_training)
(or circuit training) coveniently from your desk. The script will make your computer call out the exercises you need to do, when you need to do them. I was inspired to write this quick script after
reading the
[NY Times "The Scientific 7-Minute Workout"](http://well.blogs.nytimes.com/2013/05/09/the-scientific-7-minute-workout/)
Expand All @@ -12,6 +12,7 @@ The workout from that manuscript is the default for this script.

![Calvin Coolidge getting fit](http://files.kyle-jensen.com.s3.amazonaws.com/shared/coolidge.jpg "Calvin Coolidge getting fit")


### How it works

The shell script loops through list of exercises (potentially user-supplied)
Expand All @@ -21,6 +22,18 @@ using the [`say` command](http://www.unix.com/man-page/osx/1/SAY/).
The script sleeps between exercises using the
[`sleep` command](http://www.unix.com/man-page/osx/1/sleep/). It has only been tested on Mac OSX.


### Installation

The easiest way to install the script is to clone the repo on GitHub:

git clone https://github.com/kljensen/shell-interval-training-timer

Or you can just grab the shell script

curl -O https://raw.github.com/kljensen/shell-interval-training-timer/master/workout.sh


### Usage

First, you probably want to make the script executable
Expand Down

0 comments on commit 5bf606c

Please sign in to comment.