Skip to content

Commit d9090ab

Browse files
committed
docs(README): Update user-level configs, split docs into sections more
1 parent aebc911 commit d9090ab

File tree

1 file changed

+23
-9
lines changed

1 file changed

+23
-9
lines changed

README.rst

+23-9
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,6 @@ Save as *mysession.yaml*, and load:
4545
4646
$ tmuxp load ./mysession.yaml
4747
48-
Sessions in *~/.tmuxp/* can use names:
49-
50-
.. code-block:: sh
51-
52-
$ tmuxp load mysession
53-
5448
Projects with *.tmuxp.yaml* or *.tmuxp.json* load via directory:
5549

5650
.. code-block:: sh
@@ -65,15 +59,35 @@ Load multiple at once (in bg, offer to attach last):
6559
6660
`simple`_ and `very elaborate`_ config examples
6761

68-
Store configs in (*~/.tmuxp*) or include in your project as
69-
*~/.tmuxp.{yaml,json}*. See `author's tmuxp configs`_ and the
70-
the projects' `tmuxp.yaml`_.
62+
User-level configurations
63+
-------------------------
64+
tmuxp checks for configs in user directories:
65+
66+
- ``$TMUXP_CONFIGDIR``, if set
67+
- ``$XDG_CONFIG_HOME``, usually *$HOME/.config/tmuxp/*
68+
- ``$HOME/.tmuxp/``
69+
70+
Load your tmuxp config from anywhere by using the filename, assuming
71+
*~/.config/tmuxp/mysession.yaml* (or *.json*):
7172

73+
.. code-block:: sh
74+
75+
$ tmuxp load mysession
76+
77+
See `author's tmuxp configs`_ and the projects' `tmuxp.yaml`_.
78+
79+
Pre-load hook
80+
-------------
7281
Run custom startup scripts (such as installing project dependencies before
7382
loading tmux. See the `bootstrap_env.py`_ and `before_script`_ example
7483

84+
Load in detached state
85+
----------------------
7586
You can also load sessions in the background by passing ``-d`` flag
7687

88+
Screenshot
89+
----------
90+
7791
.. image:: https://raw.github.com/tmux-python/tmuxp/master/doc/_static/tmuxp-demo.gif
7892
:scale: 100%
7993
:width: 45%

0 commit comments

Comments
 (0)