Skip to content

Commit ef6b079

Browse files
akbakb
authored andcommitted
Document config location
1 parent 7b5f81c commit ef6b079

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

README.rst

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -310,9 +310,28 @@ For example, the ``3 seconds`` item is ready before the preceding ``4 seconds``
310310
Configuration
311311
~~~~~~~~~~~~~
312312
313-
Add code to automatically execute, into your config file.
313+
The config file location follows the `freedesktop.org standard <https://www.freedesktop.org/wiki/Software/xdg-user-dirs/>`_. Check the location on your system by running ``mario --help``:
314+
315+
316+
.. code-block:: bash
317+
318+
% mario --help
319+
Usage: mario [OPTIONS] COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]...
320+
321+
Mario: Python pipelines for your shell.
322+
323+
GitHub: https://github.com/python-mario/mario
324+
325+
Configuration:
326+
Declarative config: /home/user/.config/mario/config.toml
327+
Python modules: /home/user/.config/mario/modules/*.py
328+
329+
330+
331+
332+
For example on Ubuntu we use ``~/.config/mario/config.toml`` for declarative configuration. Add code and settings into your config.
333+
314334
315-
For example:
316335
317336
.. code-block:: toml
318337

0 commit comments

Comments
 (0)