From b9c6958ee1ca04bcaa178432e9a213de7aa1c713 Mon Sep 17 00:00:00 2001 From: Connor Slade Date: Mon, 2 Sep 2024 17:09:01 -0400 Subject: [PATCH] Small readme update --- README.md | 20 +++++++++++++++++--- TODO.md | 1 + 2 files changed, 18 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d16be52..a12e6b3 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,19 @@ -# mslicer +# mslicer [![Build](https://github.com/connorslade/mslicer/actions/workflows/build.yml/badge.svg)](https://github.com/connorslade/mslicer/actions/workflows/build.yml) -A work in progress FOSS slicer for resin printers. +An experimental open source slicer for masked stereolithography (resin) printers. +Currently only [ELEGOO](https://www.elegoo.com) `.goo` files can be generated. +You can read more about the development of this project on its [project page](https://connorcode.com/projects/mslicer). -![mslicer_BOg0d3xB6g](https://github.com/user-attachments/assets/ce2f1d99-cce8-4006-8c4f-43aecb63e53b) +![mslicer_74wLyEB9RA](https://github.com/user-attachments/assets/ca282fea-680d-4825-aca1-36d9e29fc1fe) + +## Getting Started + +You can find the latest development builds for Windows, Linux, and Mac OS on [Github Actions](https://github.com/connorslade/mslicer/actions/workflows/build.yml?query=is%3Asuccess), just open the latest workflow run and download the build artifact for your operating system. +Then run the downloaded binary and find the import model button in the file menu or drag a obj / stl file onto the window. + +## Demo Video + +Here is a demo video showing mslicer being used to slice and print [Treefrog](https://www.thingiverse.com/thing:18479) by [Morena Protti](https://www.thingiverse.com/morenap/designs). +The video is also hosted on YouTube ([here](https://youtu.be/_Xu0jFAEYLc)) if the one below doesn't play. + + diff --git a/TODO.md b/TODO.md index 6e0ac4c..d765dfd 100644 --- a/TODO.md +++ b/TODO.md @@ -83,3 +83,4 @@ - [ ] Printer profiles - [x] Save config on quit - [ ] Refactor plugins to post processors +- [ ] Update readme