From 3c668bbd2611b1d1a8d31cf77e413dabfbe02dfa Mon Sep 17 00:00:00 2001 From: Moini Date: Sun, 19 Nov 2017 00:28:57 +0100 Subject: Update README for script --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'README.md') 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 -- cgit v1.2.3 From ed8cdfa2c1352fdc506c745dcbd5d95f8ebee4bc Mon Sep 17 00:00:00 2001 From: Moini Date: Wed, 22 Nov 2017 18:24:20 +0100 Subject: Move Ubuntu install script, change message to user, update README accordingly. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 3fd4a6aa..4543aef9 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Okay, not really. I'm pretty terrible at GUIs, but I found this nifty inkscape ## Quick Setup On Ubuntu (and derivative Linux distributions) -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). +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 /inkscape-embroidery-master/bin` and then 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. -- cgit v1.2.3 From bf382475bd6265bad8878176948bc622fa5400e0 Mon Sep 17 00:00:00 2001 From: Moini Date: Sun, 26 Nov 2017 03:17:15 +0100 Subject: fix installation script for Ubuntu 16.04, add script to install libembroidery-convert, adapt README --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 4543aef9..9c234695 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,15 @@ 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) +## "Quick" Setup On Ubuntu 16.04 (and derivative Linux distributions) -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 /inkscape-embroidery-master/bin` and then 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). +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 /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'. It will compile a library needed by wxpython, this will take some (a lot of, actually...) time. 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. +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 -- cgit v1.2.3 From 8406030070e69e7ea2c0134d8bdeeb2fadb8088b Mon Sep 17 00:00:00 2001 From: Moini Date: Sun, 3 Dec 2017 02:08:57 +0100 Subject: Update README for installing wxpython via apt --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 9c234695..bea95999 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Okay, not really. I'm pretty terrible at GUIs, but I found this nifty inkscape ## "Quick" Setup On Ubuntu 16.04 (and derivative Linux distributions) -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 /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'. It will compile a library needed by wxpython, this will take some (a lot of, actually...) time. 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). +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 /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. -- cgit v1.2.3