From 66cec3a6ece0c58477aa1c1e25b851d00d03b915 Mon Sep 17 00:00:00 2001 From: Jim Myhrberg Date: Wed, 25 Apr 2012 01:07:35 +0100 Subject: [PATCH] Add super-quick "Quick Start" section to readme --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3c58aa4..fe7c8b4 100644 --- a/README.md +++ b/README.md @@ -25,10 +25,10 @@ defined directly within the session layout file. ## Example -Given we have a window layout file called [example.window.sh][example] which +Given we have a window layout file called [example.window.sh][] which looks like: -[example]: https://github.com/jimeh/tmuxifier/blob/master/examples/example.window.sh +[example.window.sh]: https://github.com/jimeh/tmuxifier/blob/master/examples/example.window.sh ```bash window_root "~/Desktop" @@ -61,6 +61,19 @@ And add the following to your `~/.profile` or equivalent: [[ -s "$HOME/.tmuxifier/init.sh" ]] && source "$HOME/.tmuxifier/init.sh" ``` +## Quick Start + +```bash +tmuxifier help +``` + +Tmuxifier doesn't come with any layouts, so you'll want to create your own +window and session layout files. New layout files are populated with examples +and comments explaining what things do. Also, having a look at the +[examples][] directory will also be good for you. + +[examples]: https://github.com/jimeh/tmuxifier/tree/master/examples + ## Configure & Customize ### Custom Installaton Path