aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorjaseg <git@jaseg.de>2022-06-17 10:43:13 +0200
committerjaseg <git@jaseg.de>2022-06-17 10:45:30 +0200
commit44fe22b6d4b8dc32cacd8f00dac8bf931625d364 (patch)
tree47ce83da9aef05d049671e685dc3d3528c379506 /README.rst
parent2c9abc7e84a9fb55789fbb4d961cde5755bc9f8f (diff)
downloadgerbolyze-44fe22b6d4b8dc32cacd8f00dac8bf931625d364.tar.gz
gerbolyze-44fe22b6d4b8dc32cacd8f00dac8bf931625d364.tar.bz2
gerbolyze-44fe22b6d4b8dc32cacd8f00dac8bf931625d364.zip
Add uninstall/update instructions to README
Fixes #15
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst21
1 files changed, 17 insertions, 4 deletions
diff --git a/README.rst b/README.rst
index ebfc7f0..6b5aaec 100644
--- a/README.rst
+++ b/README.rst
@@ -66,7 +66,19 @@ Quick Start Installation (Any Platform)
.. code-block:: shell
- pip3 install --user gerbolyze
+ python -m pip install --user gerbolyze
+
+To uninstall, run
+
+.. code-block:: shell
+
+ python -m pip uninstall gerbolyze gerbonara resvg-wasi svg-flatten-wasi
+
+To update, run
+
+.. code-block:: shell
+
+ python -m pip install --user --upgrade --upgrade-strategy eager gerbolyze
Speeding up gerbolyze using natively-built binaries
---------------------------------------------------
@@ -635,9 +647,10 @@ Gerber pass-through
~~~~~~~~~~~~~~~~~~~
Since gerbolyze has to composite your input gerbers with its own output, it has to fully parse and re-serialize them.
-gerbolyze uses pcb-tools_ and pcb-tools-extension_ for all its gerber parsing needs. Both seem well-written, but likely
-not free of bugs. This means that in rare cases information may get lost during this round trip. Thus, *always* check
-the output files for errors before submitting them to production.
+gerbolyze gerbonara_ for all its gerber parsing needs. Thus, gerbonara will interpret your gerbers and output will be in
+gerbonara's gerber "dialect". If you find a corner case where this does not work and the output looks wrong, please file
+a bug report with an example file on the gerbonara_ bug tracker. *Always* check the output files for errors before
+submitting them to production.
Gerbolyze is provided without any warranty, but still please open an issue or `send me an email
<mailto:gerbolyze@jaseg.de>`__ if you find any errors or inconsistencies.