diff --git a/README.md b/README.md index 7aa9c73..625d134 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,22 @@ # J Tech Photonics Laser Tool -This is the new official home for the (beta) JTP laser cutting Inskape extension. -The latest version of the extension is compatible with both Inskape 0.9 and Inscape 1.0, just change the "target_version" variable. A better approach is in the works. +This is the new official home for the JTP laser cutting Inskape extension. -More documentation coming soon, in the meantinìme you can refer to JTP's official website (the previous home for the extension). -Note: Pull requests are welcome, just make sure to test your code on both Python >=2.6 and >=3.5. +## Installation + +Download the latest release [here](https://github.com/JTechPhotonics/J-Tech-Photonics-Laser-Tool/releases). Make sure to select the release targeted towards the version of Inkscape you are using. You can find the version of Inkscape you're using under **Help** > **About**. + +Unzip the files directly into the Inkscape user extensions folder. Inkscape lists the location of your extensions folder under **Edit** > **Preferences** > **System**. + +Restart Inkscape and you're done. + + +## Documentation + +More documentation coming soon. In the meantime you can refer to [JTP's official website](https://jtechphotonics.com/?page_id=2012). + + +## For developers + +Pull requests are welcome both for bug fixes and new features. Just make sure to test your code on both Python >=2.6 and >=3.5.