Skip to content

Commit

Permalink
Extend the README file
Browse files Browse the repository at this point in the history
  • Loading branch information
Josef-Friedrich committed Jun 17, 2022
1 parent b835ee0 commit 18a791e
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.rst
Expand Up @@ -798,6 +798,21 @@ Usage
Example configuration file
==========================

Use the ``--config`` option to load a configuration file. The command
line arguments overwrite the corresponding options of the configuration
file.

.. code-block:: Shell
audiorenamer --config /home/user/my-config.ini
Almost all command line arguments have a corresponding option in the
configuration file. ``audiorename`` implements a basic configuration
language which provides a structure similar to what’s found in Microsoft
Windows `INI
<https://docs.python.org/3/library/configparser.html#supported-ini-file-structure>`_
files:

.. code-block:: ini
[selection]
Expand Down
15 changes: 15 additions & 0 deletions README_template.rst
Expand Up @@ -71,6 +71,21 @@ Usage
Example configuration file
==========================

Use the ``--config`` option to load a configuration file. The command
line arguments overwrite the corresponding options of the configuration
file.

.. code-block:: Shell
audiorenamer --config /home/user/my-config.ini
Almost all command line arguments have a corresponding option in the
configuration file. ``audiorename`` implements a basic configuration
language which provides a structure similar to what’s found in Microsoft
Windows `INI
<https://docs.python.org/3/library/configparser.html#supported-ini-file-structure>`_
files:

.. code-block:: ini
<< config file >>
Expand Down

0 comments on commit 18a791e

Please sign in to comment.