diff options
| author | jaseg <git@jaseg.de> | 2023-02-25 17:31:16 +0100 |
|---|---|---|
| committer | jaseg <git@jaseg.de> | 2023-02-25 17:31:16 +0100 |
| commit | 8b40d15dab376c92b37b0939515e7bdee7b83301 (patch) | |
| tree | 1a9b1d513300cf17109d19d16e95fbb0e0a7e99f /docs/index.rst | |
| parent | d43eff8b49022719b2933e8429a05e3a35b8762f (diff) | |
| download | gerbonara-8b40d15dab376c92b37b0939515e7bdee7b83301.tar.gz gerbonara-8b40d15dab376c92b37b0939515e7bdee7b83301.tar.bz2 gerbonara-8b40d15dab376c92b37b0939515e7bdee7b83301.zip | |
Moar doc
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/docs/index.rst b/docs/index.rst index ab363c6..45dbc1b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -46,6 +46,7 @@ Features :maxdepth: 2 :caption: Contents: + cli api-concepts file-api object-api @@ -73,6 +74,18 @@ Then, you are ready to read and write gerber files: w, h = stack.outline.size('mm') print(f'Board size is {w:.1f} mm x {h:.1f} mm') +Command-Line Interface +====================== + +Gerbonara comes with a :ref:`built-in command-line interface<cli-doc>` that has functions for analyzing, rendering, +modifying, and merging Gerber files. To access it, use either the ``gerbonara`` command that is part of the python +package, or run ``python -m gerbonara``. For a list of functions or help on their usage, you can use: + +.. code:: console + + $ python -m gerbonara --help + [...] + $ python -m gerbonara render --help Development =========== @@ -93,7 +106,7 @@ A copy of this documentation can also be found at gitlab: https://gerbolyze.gitlab.io/gerbonara/ -With Gebronara, we aim to support as many different format variants as possible. If you have a file that Gerbonara can't +With Gerbonara, we aim to support as many different format variants as possible. If you have a file that Gerbonara can't open, please file an issue on our issue tracker. Even if Gerbonara can open all your files, for regression testing we are very interested in example files generated by any CAD or CAM tool that is not already on the list of supported tools. |