Skip to content

Commit f84271f

Browse files
committed
Update README
1 parent a1054e0 commit f84271f

File tree

1 file changed

+2
-59
lines changed

1 file changed

+2
-59
lines changed

README.rst

Lines changed: 2 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ tmux bash completion
3030
.. seealso:: `bash completion`_
3131

3232
load tmux sessions from yaml and json
33-
""""""""""""""""""""""""""""""""""""""
33+
"""""""""""""""""""""""""""""""""""""
3434

3535
.. code-block:: bash
3636
@@ -83,64 +83,7 @@ With ``tmuxp``:
8383
8484
$ tmuxp load test.yaml
8585
86-
.. seealso:: `Quickstart`_
87-
88-
tmuxp works in 3 ways:
89-
90-
- a pythonic `abstraction layer`_ on top of tmux' CLI commands
91-
- an `ORM`_ that internally orchestrates relations between servers,
92-
sessions, windows and panes for good and evil purposes.
93-
- CLI tmux session manager, similar to `teamocil`_ and `tmuxinator`_, with
94-
support for YAML, JSON and python dicts.
95-
96-
Advanced tmux workflow
97-
""""""""""""""""""""""
98-
99-
.. code-block:: yaml
100-
101-
session_name: tmuxp
102-
windows:
103-
- window_name: tmuxp
104-
layout: main-horizontal
105-
options:
106-
main-pane-height: 50
107-
start_directory: ./
108-
shell_command_before:
109-
- '[ -d .env -a -f .env/bin/activate ] && source .env/bin/activate || virtualenv .env'
110-
panes:
111-
- shell_command:
112-
- vim
113-
- :Ex
114-
focus: true
115-
- shell_command:
116-
- echo hi
117-
- shell_command:
118-
- '[ -d .env -a -f .env/bin/activate ] || virtualenv .env'
119-
- command -v tmuxp >/dev/null 2>&1 || { pip install -e .; }
120-
- command -v watching_testrunner >/dev/null 2>&1 || { pip install watching_testrunner; }
121-
- watching_testrunner --basepath ./ --pattern="*.py" 'python run_tests.py'
122-
- window_name: docs
123-
layout: main-horizontal
124-
options:
125-
main-pane-height: 50
126-
start_directory: ./
127-
automatic_rename: true
128-
shell_command_before:
129-
- '[ -d .env -a -f .env/bin/activate ] && source .env/bin/activate || virtualenv .env'
130-
- command -v tmuxp >/dev/null 2>&1 || { pip install -e .; }
131-
- cd ./doc
132-
panes:
133-
- shell_command:
134-
- vim
135-
focus: true
136-
- pwd
137-
- echo 'docs built to <http://0.0.0.0:8000/_build/html>'; python -m SimpleHTTPServer
138-
- shell_command:
139-
- command -v sphinx-quickstart >/dev/null 2>&1 || { pip install -r requirements.pip; }
140-
- command -v watching_testrunner >/dev/null 2>&1 || { pip install watching_testrunner; }
141-
- watching_testrunner --basepath ./ --pattern="*.rst" 'make html'
142-
143-
see this in the `Developing and Testing`_ documentation page.
86+
See also: `Quickstart`_
14487

14588
============== ==========================================================
14689
tmux support 1.8, 1.9-dev

0 commit comments

Comments
 (0)