Merge branch 'master' of github.com:lexelby/inkscape-embroidery

README.md

@@ -11,8 +11,17 @@ 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 16.04 (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 from the archive's `bin` directory by first changing into that directory with `cd <path_to_the_archive>/inkscape-embroidery-master/bin` and then entering the command `sh install_ink_embroidery_Ubuntu.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. Intermittently, it will require you to confirm a step by hitting Enter, or typing in 'y' or 'yes'. 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).
+
+To also install the optional conversion program, run `sh install_libembroidery-convert.sh` in the same directory. This script will also ask your password in order to be able to install the necessary dependencies.
+
+Not tested with Ubuntu versions other than 16.04. If you try it out, please let us know how it went.
+
+Continue reading in the "Usage" section.
+
+## 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.
 
@@ -30,7 +39,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
 

bin/install_ink_embroidery_Ubuntu.sh

@@ -0,0 +1,63 @@
+# This file is part of the Inkscape extension 'inkscape-embroidery', 
+# an extension for machine embroidery design using Inkscape.
+
+# Copyright (C) 2017 Maren Hachmann
+
+# inkscape-embroidery is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# inkscape-embroidery is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with inkscape-embroidery.  If not, see <http://www.gnu.org/licenses/>.
+
+#!/bin/bash
+
+# we want to be in the tmp directory
+cd /tmp
+
+# delete old snap Inkscape (we really don't want a snap!)
+sudo snap remove inkscape
+
+echo "Adding Inkscape stable apt-repository"
+
+# add stable-daily repository
+sudo add-apt-repository ppa:inkscape.dev/stable
+
+# refresh package list
+sudo apt-get update
+
+# install everything we need
+sudo apt-get install inkscape python-pip unzip python-wxgtk3.0
+
+# download lexelby's embroidery extension
+wget https://github.com/lexelby/inkscape-embroidery/archive/master.zip
+
+# unzip files
+unzip master.zip -d /tmp
+
+# change into new directory
+cd inkscape-embroidery-master
+
+# upgrade pip
+pip install -U pip
+
+# install requirements (only with user privileges, not system-wide)
+pip install --user -r requirements.txt
+
+# create extensions directory if doesn't exist yet
+mkdir -p $HOME/.config/inkscape/extensions
+
+# copy all *.py and *.inx files there
+cp *.py *.inx $HOME/.config/inkscape/extensions
+
+echo "============================
+
+The Inkscape embroidery extension (https://github.com/lexelby/inkscape-embroidery) and its dependencies have been installed, and your Inkscape version is now up to date.
+
+Any previously installed Inkscape snap packages have been removed."

bin/install_libembroidery-convert_Ubuntu.sh

@@ -0,0 +1,58 @@
+# This file is part of the Inkscape extension 'inkscape-embroidery', 
+# an extension for machine embroidery design using Inkscape.
+
+# Copyright (C) 2017 Maren Hachmann
+
+# inkscape-embroidery is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# inkscape-embroidery is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with inkscape-embroidery.  If not, see <http://www.gnu.org/licenses/>.
+
+#!/bin/bash
+
+# make sure we're in tmp directory
+cd /tmp
+
+# install qmake (which is needed to configure libembroidery)
+sudo apt-get install qt4-qmake
+
+# get the source for embroidermodder
+wget https://github.com/Embroidermodder/Embroidermodder/archive/master.zip -O /tmp/embroidermodder-master.zip
+
+# unzip files
+unzip embroidermodder-master.zip -d /tmp
+
+# switch into directory of the library we're interested in
+cd Embroidermodder-master/libembroidery-convert/
+
+# prepare build
+qmake
+
+# build
+make
+
+# create destination folder (which will automatically be in the PATH environment variable)
+mkdir -p $HOME/bin/
+
+# copy created library there
+cp ./libembroidery-convert $HOME/bin/
+
+echo "==========================
+
+Use the embroidery file format conversion tool like this:
+
+libembroidery-convert file_to_read file_to_write
+
+To get a list of supported embroidery formats, enter:
+
+libembroidery-convert --help
+
+Run this script again to update your libembroidery-convert version."

images/patches/README.md

@@ -1,4 +1,4 @@
-![soulstorm_brew_patch.jpg](soulstorm_brew_patch.jpg) ![soulstorm_brew_orig.jpg](soulstorm_brew_orig.jpg)
+[<img src="soulstorm_brew_patch.jpg" width="300">](soulstorm_brew_patch.jpg) ![soulstorm_brew_orig.jpg](soulstorm_brew_orig.jpg)
 ![super_hero_patch.jpg](super_hero_patch.jpg)
 ![orca_patch.jpg](orca_patch.jpg)
 ![amazon_checkmark_i.jpg](amazon_checkmark_i.jpg)