Skip to content

Commit aa63c80

Browse files
committed
Documentation updates for README, about
1 parent 02639aa commit aa63c80

File tree

3 files changed

+9
-24
lines changed

3 files changed

+9
-24
lines changed

README.rst

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -20,31 +20,14 @@ tmuxp, a novel approach to manage `tmux(1)`_ (>= 1.8) workspaces through
2020
- `bash, zsh and tcsh`_ completion.
2121
- Unit tested against against live tmux (1.8 and git). See `travis.yml`_
2222
file, `tmuxp on Travis CI`_ and `testing`_ page.
23-
- `Documentation`_, `Examples`_, `Internals`_.
23+
- `Documentation`_, `Examples`_, `Commands`_, `Internals`_.
2424
- and `much, much more`_.
2525

2626
Ready to begin? See the `Quickstart`_.
2727

28-
CLI Commands
29-
""""""""""""
30-
31-
========================== ===============================================
32-
``tmuxp attach-session`` ``<session_name>``
33-
tmuxp uses ``switch-client`` if already inside
34-
tmux client.
35-
``tmuxp kill-session`` ``<session name>``
36-
``tmuxp freeze`` ``<session name>``
37-
``tmuxp load`` ``<file>``
38-
Load a workspace yaml / json file.
39-
If session already made, will offer to attach.
40-
``tmuxp convert`` ``<file>``
41-
Convert session yaml / json.
42-
``tmuxp import`` ``[teamocil | tmuxinator]`` ``<file>``
43-
Import a `teamocil`_ or `tmuxinator`_ config.
44-
========================== ===============================================
45-
4628
============== ==========================================================
4729
tmux support 1.8, 1.9-dev
30+
python support 2.7, >= 3.3
4831
config support yaml, json, python dict
4932
Travis http://travis-ci.org/tony/tmuxp
5033
Docs http://tmuxp.rtfd.org
@@ -89,6 +72,7 @@ tests .. code-block:: bash
8972
.. _much, much more: http://tmuxp.readthedocs.org/en/latest/about.html#minor-tweaks
9073
.. _Quickstart: http://tmuxp.readthedocs.org/en/latest/quickstart.html
9174
.. _Internals: http://tmuxp.readthedocs.org/en/latest/internals.html
75+
.. _Commands: http://tmuxp.readthedocs.org/en/latest/cli.html
9276

9377
.. _BSD: http://opensource.org/licenses/BSD-3-Clause
9478
.. _developing and testing: http://tmuxp.readthedocs.org/en/latest/developing.html

doc/about.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
About
77
=====
88

9-
tmuxp helps you manage your text-based workspaces. Its BSD licensed.
9+
tmuxp helps you manage tmux workspaces. Its BSD licensed.
1010

11-
Internally, tmuxp is an object relational mapper on top of tmux.
12-
End-users may use YAML, JSON and :py:obj:`dict` configurations to launch
13-
workspaces like `tmuxinator`_ and `teamocil`_.
11+
tmuxp is build upon an object relational mapper for tmux. End-users may
12+
use YAML, JSON and :py:obj:`dict` configurations to launch workspaces like
13+
`tmuxinator`_ and `teamocil`_.
1414

1515
To jump right in, see :ref:`quickstart` and :ref:`examples`.
1616

doc/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ tmuxp, a novel approach to manage `tmux(1)`_ (>= 1.8) workspaces through
1616
- `bash, zsh and tcsh`_ completion.
1717
- Unit tested against against live tmux (1.8 and git). See `travis.yml`_
1818
file, `tmuxp on Travis CI`_ and `testing`_ page.
19-
- `Documentation`_, `Examples`_, `Internals`_.
19+
- `Documentation`_, `Examples`_, `Commands`_, `Internals`_.
2020
- and `much, much more`_.
2121

2222
Ready to begin? See the `Quickstart`_.
@@ -38,6 +38,7 @@ Ready to begin? See the `Quickstart`_.
3838
.. _much, much more: http://tmuxp.readthedocs.org/en/latest/about.html#minor-tweaks
3939
.. _Quickstart: http://tmuxp.readthedocs.org/en/latest/quickstart.html
4040
.. _Internals: http://tmuxp.readthedocs.org/en/latest/internals.html
41+
.. _Commands: http://tmuxp.readthedocs.org/en/latest/cli.html
4142

4243
Explore:
4344

0 commit comments

Comments
 (0)