summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMoini <Moini@users.noreply.github.com>2017-11-19 00:28:57 +0100
committerGitHub <noreply@github.com>2017-11-19 00:28:57 +0100
commit3c668bbd2611b1d1a8d31cf77e413dabfbe02dfa (patch)
tree53776d6865b07ad1712530eca8db1473ca597f36
parent4c9cccfa5c3487f33e50bfdada570e9217a2a396 (diff)
Update README for script
-rw-r--r--README.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/README.md b/README.md
index f1e2265c..3fd4a6aa 100644
--- a/README.md
+++ b/README.md
@@ -8,8 +8,13 @@ So I wrote one.
Okay, not really. I'm pretty terrible at GUIs, but I found this nifty inkscape extension that was created and hacked on by a couple of other folks. It was pretty rudimentary, but it got the job done, and more importantly, it was super hackable. I hacked the hell out of it, and at this point **inkscape-embroidery is a viable entry-level machine embroidery design tool**.
+## Quick Setup On Ubuntu (and derivative Linux distributions)
-## Setup
+Download the [extension's archive file](https://github.com/lexelby/inkscape-embroidery/archive/master.zip) and unpack the zip archive. Then, on a terminal, run the installation (and update) script by entering the command `sh install.sh`. The script will ask for your password to be able to install new software, remove any Inkscape snap packages that may be installed, and to update Inkscape to the current version. Restart Inkscape after the script has executed to see the changes take effect. You can also run the script again when you later want to update the extension (and Inkscape).
+
+Currently, the optional conversion program still needs to be installed manually, if desired.
+
+## Manual Setup
To use this tool, you're going to need to set it up. It's an inkscape extension written as a Python file. Once you get it working, you'll need to learn how to design vectors in the way that inkscape-embroidery expects, and then you can generate your design files.
@@ -27,7 +32,7 @@ pip install -r requirements.txt
### Extension installation
1. Clone the extension source: `git clone https://github.com/lexelby/inkscape-embroidery`
-2. Install it as directed [here](https://inkscape.org/da/gallery/%3Dextension/)
+2. Install it as directed [here](https://inkscape.org/en/gallery/%3Dextension/)
I prefer to symbolically link into my git clone, which allows me to hack on the code. Changes to the Python code take effect the next time the extension is run. Changes to the extension description files (`*.inx`) take effect the next time Inkscape is restarted