aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjaseg <git@jaseg.de>2021-02-06 00:14:01 +0100
committerjaseg <git@jaseg.de>2021-02-06 00:14:01 +0100
commitf95a24ebb97ab0e00e8c2fa248d962c1e37134a0 (patch)
treeba6a4f4ded26a2d91d3b74b589a4cbe09a243661
parent8c494f77361a6774a30ee86a86c40c4bdeeda83a (diff)
downloadgerbolyze-f95a24ebb97ab0e00e8c2fa248d962c1e37134a0.tar.gz
gerbolyze-f95a24ebb97ab0e00e8c2fa248d962c1e37134a0.tar.bz2
gerbolyze-f95a24ebb97ab0e00e8c2fa248d962c1e37134a0.zip
Finish up initial draft of install doc
-rw-r--r--README.rst47
1 files changed, 34 insertions, 13 deletions
diff --git a/README.rst b/README.rst
index befaf27..4289474 100644
--- a/README.rst
+++ b/README.rst
@@ -49,43 +49,64 @@ Gerbolyze works in three steps.
$ gerbolyze paste --top template_top_edited.svg [--bottom ...] my_gerber_dir output_gerber_dir
-Installation
-------------
+Quick Start Installation
+------------------------
+
+This will install gerbolyze and svg-flatten into a Python virtualenv and install usvg into your ``~/.cargo`` if not yet
+installed somewhere else.
Debian
~~~~~~
-Step 1: Install dependencies
-****************************
-
-.. note::
+Note
Right now, debian stable ships with a rust that is so stable it can't even build half of usvg's dependencies. That's
why we yolo-install our own rust here. Sorry about that. I guess it'll work with the packaged rust on sid.
.. code-block:: shell
- git clone --recurse-submodules https://git.jaseg.de/gerbolyze.git
- cd gerbolyze
+ sudo apt install libopencv-dev libpugixml-dev libpangocairo-1.0-0 libpango1.0-dev libcairo2-dev clang make python3 git python3-wheel curl python3-pip python3-venv
+
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source $HOME/.cargo/env
- sudo apt install libopencv-dev libpugixml-dev libpangocairo-1.0-0 libpango1.0-dev libcairo2-dev clang make python3 git python3-wheel curl
+
+ git clone --recurse-submodules https://git.jaseg.de/gerbolyze.git
+ cd gerbolyze
+
+ python3 -m venv
+ source venv/bin/activate
+ # may take a while during usvg install
python3 setup.py install
Fedora
~~~~~~
-Step 1: Install dependencies
-****************************
-
.. code-block:: shell
+ sudo dnf install python3 make clang opencv-devel pugixml-devel pango-devel cairo-devel rust cargo
+
git clone --recurse-submodules https://git.jaseg.de/gerbolyze.git
cd gerbolyze
- sudo dnf install python3 make clang opencv-devel pugixml-devel pango-devel cairo-devel rust cargo
+
+ python3 -m venv
+ source venv/bin/activate
+ # may take a while during usvg install
+ python3 setup.py install
Arch
~~~~
+.. code-block:: shell
+
+ sudo pacman -S pugixml opencv pango cairo git python make clang rustup cargo
+
+ git clone --recurse-submodules https://git.jaseg.de/gerbolyze.git
+ cd gerbolyze
+
+ python3 -m venv
+ source venv/bin/activate
+ # may take a while during usvg install
+ python3 setup.py install
+
Features
--------