jimeh/tmuxifier
1
0
Fork 0
mirror of https://github.com/jimeh/tmuxifier.git synced 2026-02-19 01:46:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add super-quick "Quick Start" section to readme

Browse Source
This commit is contained in:
Jim Myhrberg
2012-04-25 01:07:35 +01:00
parent ffe9327758
commit 66cec3a6ec
1 changed files with 15 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -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