Skip to content

Commit 53290fa

Browse files
committed
README, doc updates
1 parent 94142f4 commit 53290fa

File tree

3 files changed

+10
-12
lines changed

3 files changed

+10
-12
lines changed

README.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -77,12 +77,11 @@ Install ``tmuxp``:
7777
- pwd
7878
- pwd
7979
80-
81-
Now with ``tmuxp``:
80+
With ``tmuxp``:
8281

8382
.. code-block:: bash
8483
85-
$ tmuxp test.yaml
84+
$ tmuxp load test.yaml
8685
8786
.. seealso:: `Quickstart`_
8887

@@ -94,7 +93,6 @@ tmuxp works in 3 ways:
9493
- CLI tmux session manager, similar to `teamocil`_ and `tmuxinator`_, with
9594
support for YAML, JSON and python dicts.
9695

97-
9896
Advanced tmux workflow:
9997

10098
.. code-block:: yaml
@@ -181,7 +179,7 @@ tests .. code-block:: bash
181179
.. _tmuxinator: https://github.com/aziz/tmuxinator
182180
.. _teamocil: https://github.com/remiprev/teamocil
183181
.. _abstraction layer: http://en.wikipedia.org/wiki/Abstraction_layer
184-
.. _ORM: http://en.wikipedia.org/wiki/Object-relational_mapping
182+
.. _ORM: http://tmuxp.readthedocs.org/en/latest/quickstart.html#tmux-orm
185183
.. _tmux(1): http://tmux.sourceforge.net/
186184
.. _Issues tracker: https://github.com/tony/tmuxp/issues
187185
.. _python dict: http://docs.python.org/2/library/stdtypes.html#dict

doc/developing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ After you :ref:`install_dev_env`, when inside the tmuxp checkout:
200200

201201
.. code-block:: bash
202202
203-
$ tmuxp .
203+
$ tmuxp load .
204204
205205
this will load the ``.tmuxp.yaml`` in the root of the project.
206206

doc/quickstart.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@ with tmuxp:
2727

2828
.. code-block:: bash
2929
30-
$ tmuxp -l
30+
$ tmuxp load -l
3131
3232
It will list configs available in the current directory and
3333
``$HOME/.tmuxp``. ``example.yaml`` is detected by tmuxp.
3434

3535
.. code-block:: bash
3636
37-
$ tmuxp example.yaml
37+
$ tmuxp load example.yaml
3838
3939
This creates your tmuxp session.
4040

@@ -71,12 +71,12 @@ For zsh:
7171
Python ORM + AL
7272
---------------
7373

74-
`ORM` - Object Relational Mapper
74+
ORM - `Object Relational Mapper`_
7575

76-
`AL`_ - Abstraction Layer
76+
AL - `Abstraction Layer`_
7777

78-
.. _abstraction layer: http://en.wikipedia.org/wiki/Abstraction_layer
79-
.. _ORM: http://en.wikipedia.org/wiki/Object-relational_mapping
78+
.. _Abstraction Layer: http://en.wikipedia.org/wiki/Abstraction_layer
79+
.. _Object Relational Mapper: http://en.wikipedia.org/wiki/Object-relational_mapping
8080

8181
python abstraction layer
8282
""""""""""""""""""""""""

0 commit comments

Comments
 (0)