@@ -8,31 +8,60 @@ tmuxp, a novel approach to manage `tmux(1)`_ (>= 1.8) workspaces through
88 :width: 45%
99 :align: center
1010
11- - Basic support for `freezing live sessions `_.
12- - `Importing `_ from `teamocil `_ and `tmuxinator `_.
13- - JSON or YAML for `simple `_ or `very elaborate `_ configurations.
14- - `bash, zsh and tcsh `_ completion.
15- - Unit tested against live tmux (1.8 and git). See `travis.yml `_
16- file, `tmuxp on Travis CI `_ and `testing `_ page.
17- - `Documentation `_ (also in `中文 `_), `Examples `_, `Source `_,
11+ How tmuxp helps you tmux:
12+
13+ - Save your most common tmux session layouts in JSON or YAML. See
14+ a `simple `_ or `very elaborate `_ configuration.
15+ - Store layouts personally (``~/.tmuxp ``) or include in your project,
16+ see ``~/.tmuxp.{yaml,json} ``. See the `author's tmuxp configs `_ and the
17+ the projects' `tmuxp.yaml `_.
18+ - `Freeze `_ the layout of live sessions.
19+ - Automate running such as sourcing into a `virtualenv `_. The configuration
20+ also supports per window commands where all panes inherit commands. See
21+ `Examples `_.
22+ - Run a bootstrapping script to check environment / install dependencies /
23+ setup project before loading starts so your development works across
24+ systems. See this projects `bootstrap_env.py `_ and `before_script `_ example.
25+ - Load tmux sessions in the background by passing ``-d `` flag.
26+ - Load multiple tmux configurations ``tmuxp load config1.yaml
27+ config2.yaml ``.
28+ - Switch sessions from inside a current tmux session. tmuxp will detect
29+ if you're in a session and offer to ``switch-session `` for you.
30+ - Offer to re-attach a tmux session if your config is already loaded.
31+ - For more things you can do with tmuxp, see `Examples `_.
32+ - CLI auto-completion with `bash, zsh and tcsh `_.
33+ - Use as a `python library `_, see the `python API quickstart `_.
34+ - Well tested a gain against live tmux (1.8+ and git).
35+ See `travis.yml `_, `tmuxp on Travis CI `_ and `testing `_ page.
36+ - `Import `_ configs `teamocil `_ and `tmuxinator `_.
37+ - Thorough `Documentation `_ (also in `中文 `_), `Source `_,
1838 `Commands `_, `Internals `_.
1939- and `much, much more `_.
2040
2141Ready to begin? See the `Quickstart `_.
42+ Want to learn more about tmux itself? Read `The Tao of Tmux `_.
2243
2344.. _tmuxp on Travis CI : http://travis-ci.org/tony/tmuxp
2445.. _Documentation : http://tmuxp.rtfd.org/
2546.. _Source : https://github.com/tony/tmuxp
2647.. _中文 : http://tmuxp-zh.rtfd.org/
48+ .. _before_script : http://localhost:8003/_build/html/examples.html#bootstrap-project-before-launch
49+ .. _virtualenv : https://virtualenv.readthedocs.org/en/latest/
50+ .. _The Tao of tmux : http://localhost:8003/_build/html/about_tmux.html
51+ .. _author's tmuxp configs : https://github.com/tony/tmuxp-config
52+ .. _python library : https://tmuxp.readthedocs.org/en/latest/api.html
53+ .. _python API quickstart : https://tmuxp.readthedocs.org/en/latest/quickstart_python.html
2754.. _tmux(1) : http://tmux.sourceforge.net/
2855.. _tmuxinator : https://github.com/aziz/tmuxinator
2956.. _teamocil : https://github.com/remiprev/teamocil
3057.. _Examples : http://tmuxp.readthedocs.org/en/latest/examples.html
31- .. _freezing live sessions : http://tmuxp.readthedocs.org/en/latest/cli.html#freeze-sessions
32- .. _Importing : http://tmuxp.readthedocs.org/en/latest/cli.html#import
58+ .. _Freeze : http://tmuxp.readthedocs.org/en/latest/cli.html#freeze-sessions
59+ .. _bootstrap_env.py : https://github.com/tony/tmuxp/blob/master/bootstrap_env.py
60+ .. _Import : http://tmuxp.readthedocs.org/en/latest/cli.html#import
3361.. _travis.yml : http://tmuxp.readthedocs.org/en/latest/developing.html#travis-ci
3462.. _testing : http://tmuxp.readthedocs.org/en/latest/developing.html#test-runner
3563.. _python objects : http://tmuxp.readthedocs.org/en/latest/api.html#api
64+ .. _tmuxp.yaml : https://github.com/tony/tmuxp/blob/master/.tmuxp.yaml
3665.. _simple : http://tmuxp.readthedocs.org/en/latest/examples.html#short-hand-inline
3766.. _very elaborate : http://tmuxp.readthedocs.org/en/latest/examples.html#super-advanced-dev-environment
3867.. _bash, zsh and tcsh : http://tmuxp.readthedocs.org/en/latest/cli.html#bash-completion
0 commit comments