Skip to content

Commit 75db05b

Browse files
committed
Documentation clarification for loading tmux project files, doc fix.
1 parent 29a7014 commit 75db05b

File tree

2 files changed

+14
-11
lines changed

2 files changed

+14
-11
lines changed

doc/examples.rst

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -246,20 +246,19 @@ JSON
246246
.. literalinclude:: ../.tmuxp.json
247247
:language: json
248248

249-
Run script before launch
250-
------------------------
249+
Bootstrap project before launch
250+
-------------------------------
251251

252252
You can use ``before_script`` to run a script before the tmux session
253-
starts building.
253+
starts building. This can be used to start a script to create a virtualenv
254+
or download a virtualenv/rbenv/package.json's dependency files before
255+
tmuxp even begins building the session.
254256

255257
It works by using the `Exit Status`_ code returned by a script. Your
256258
script can be any type, including bash, python, ruby, etc.
257259

258260
A successful script will exit with a status of ``0``.
259261

260-
You can use this for things like bootstrapping ruby / python environments
261-
for a project (or checking to verify their installation).
262-
263262
Important: the script file must be chmod executable ``+x`` or ``755``.
264263

265264
Run a python script (and check for it's return code), the script is
@@ -297,14 +296,18 @@ and panes omitted in this example)
297296
298297
.. _Exit Status: http://tldp.org/LDP/abs/html/exit-status.html
299298

300-
Project configs
301-
---------------
299+
Per-project tmux config
300+
-----------------------
301+
302+
You can load your software project in tmux by placing a ``.tmuxp.yaml`` or
303+
``.tmuxp.json`` in the project's config and loading it.
302304

303305
tmuxp supports loading configs via absolute filename with ``tmuxp load``
304306
and via ``$ tmuxp load .`` if config is in directory.
305307

306-
To make a per-project config, use ``.tmuxp.yaml`` and ``.tmuxp.json`` in
307-
the root of your project directory.
308+
.. bash::
309+
310+
$ tmuxp load ~/workspaces/myproject.yaml
308311

309312
See examples of ``tmuxp`` in the wild. Have a project config to show off?
310313
Edit this page.

doc/internals.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ What is a {pane,window}_index vs a {pane,window,session}_id?
7575

7676
Pane index refers to the order of a pane on the screen.
7777

78-
Window index refers to the # of the pane in the session.
78+
Window index refers to the # of the window in the session.
7979

8080
To assert pane, window and session data, tmuxp will use
8181
:meth:`Server.list_sessions()`, :meth:`Session.list_windows()`,

0 commit comments

Comments
 (0)