sameer / svg2gcode

Convert vector graphics to g-code for pen plotters, laser engravers, and other CNC machines
https://sameer.github.io/svg2gcode
MIT License
241 stars 48 forks source link

Release to Website Instructions #27

Closed 1fifoto closed 5 months ago

1fifoto commented 2 years ago

Sameer, I'm interested in installing your code in my own development environment to do a pull-request so I can create an update for you. However, I'm new to Rust and wondered if you have a write-up somewhere on how to install the prerequisites on a "empty" machine with only the OS installed. And then where to install your svg2gcode code project on that machine to get it running. I've cloned your project and see the Github Actions, but I've been unsuccessful it getting them to work to create a github.io website either. So there must be some Github settings that I am missing. Any help would be appreciated. Brian Watt, @1fifoto or bwatt@1fifoto.com

sameer commented 2 years ago

Hi Brian,

Thanks for reaching out! The tools you need to install should be: cargo + rust & trunk. You'll also need the wasm target installed: rustup target install wasm32-unknown-unknown.

The website is on a separate git branch gh-pages and is automatically deployed to GH pages using the web-deploy github action. To build the website locally:

# inside the repo
cd web
trunk serve
# Website will be accessible at some localhost address

You can use trunk build to get a release build of the website. Let me know if there's anything else I can help with!

1fifoto commented 2 years ago

Thank you, let me read and give it a try.