mirror of
https://github.com/Steffo99/emblematic.git
synced 2024-11-26 00:24:19 +00:00
56 lines
1.9 KiB
ReStructuredText
56 lines
1.9 KiB
ReStructuredText
|
*******************************************************************************
|
||
|
|
Usage
|
||
|
|
*******************************************************************************
|
||
|
|
|
||
|
|
:mod:`emblematic` currently supports only a single mode of operation.
|
||
|
|
|
||
|
|
|
||
|
|
=======================
|
||
|
|
Generate a basic emblem
|
||
|
|
=======================
|
||
|
|
|
||
|
|
A *basic emblem* can be generated by running:
|
||
|
|
|
||
|
|
.. code-block:: console
|
||
|
|
|
||
|
|
$ emblematic basic --background="./bg.svg" --icon="./icon.svg" --fill="#feedb4" --output-dir="./output/"
|
||
|
|
|
||
|
|
It is composed by:
|
||
|
|
|
||
|
|
1. taking the SVG background image contained in the file given as the ``--background`` option, such as the following:
|
||
|
|
|
||
|
|
.. figure:: ryg6-bg.svg
|
||
|
|
:width: 150
|
||
|
|
:height: 150
|
||
|
|
|
||
|
|
2. overlaying a rescaled version of the SVG foreground icon contained in the file given as the ``--icon`` option, filled with the color given in the ``--fill`` option, such as the following:
|
||
|
|
|
||
|
|
.. figure:: fontawesome-ice-cream.svg
|
||
|
|
:width: 150
|
||
|
|
:height: 150
|
||
|
|
|
||
|
|
3. converting the resulting document to a 2000x2000 PNG file for better compatibility with applications (very few support correctly the ``preserveAspectRatio`` property):
|
||
|
|
|
||
|
|
.. figure:: ryg6-ice-cream.png
|
||
|
|
:width: 150
|
||
|
|
:height: 150
|
||
|
|
|
||
|
|
|
||
|
|
---------------------------------
|
||
|
|
Multiple emblems with one command
|
||
|
|
---------------------------------
|
||
|
|
|
||
|
|
Multiple emblem files can be generated at once.
|
||
|
|
|
||
|
|
* Pass the ``--icon`` parameter multiple times to generate emblems with the same settings but different icons:
|
||
|
|
|
||
|
|
.. code-block:: console
|
||
|
|
|
||
|
|
$ emblematic basic --background="./bg.svg" --icon="./icon1.svg" --icon="./icon2.svg" --icon="./icon3.svg" --fill="#feedb4" --output-dir="./output/"
|
||
|
|
|
||
|
|
* Pass a directory as the ``--icon`` parameter to render all contained files matched by the ``**/*.svg`` glob:
|
||
|
|
|
||
|
|
.. code-block:: console
|
||
|
|
|
||
|
|
$ emblematic basic --background="./bg.svg" --icon="./fontawesome/" --fill="#feedb4" --output-dir="./output/"
|