From c150d8dd749b15e3fe1d6dfc899585c377f6e390 Mon Sep 17 00:00:00 2001 From: Laserology <167719528+Laserology@users.noreply.github.com> Date: Fri, 6 Sep 2024 01:31:21 -0700 Subject: [PATCH 1/8] Update README.md --- README.md | 38 +++++++++++++++++--------------------- 1 file changed, 17 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 14eadda93e..60f0df7c11 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,33 @@ -# MeerK40t +# Welcome to MeerK40t! MeerK40t (pronounced MeerKat) is a built-from-the-ground-up MIT licensed open-source laser cutting software. ## Primary Goals * Provide users with high quality laser control software. * Provide developers with a highly extensible platform to help further their own ideas, and provide novel work to the laser community at large. -## Running -MeerK40t is written in Python and precompiled versions are [available for download](https://github.com/meerk40t/meerk40t/releases) for Windows, Mac OSX, Linux and Raspberry Pi (more infos below). Do note this sometimes will give false postitives for various viruses (especially since Meerk40t isn't signed). +## Getting started +To get up and running, simply download Meerk40t from [here](https://github.com/meerk40t/meerk40t/releases) for your specific platform. (Windows, Mac OSX, Linux, and by extension, Raspberry Pi). -### Source +### Release versions: +> * 0.9 - Active - New features and some underlying architectural changes. Try the latest released version: [0.9.4](https://github.com/meerk40t/meerk40t/releases#latest) +> * 0.8 - Maintenance - may receive critical bugfixes but no more new features, latest version: [0.8.12](https://github.com/meerk40t/meerk40t/releases/tag/0.8.12000) (Oct 17, 2023) +> * 0.7 - Discontinued - K40 support only (including ruidacontrol emulator for 3rd party lasersoftware integration), latest version [0.7.10](https://github.com/meerk40t/meerk40t/releases/tag/0.7.10000) (June 13, 2023) +> * 0.6 - Discontinued - K40 support only, latest version: [0.6.24](https://github.com/meerk40t/meerk40t/releases/tag/0.6.24) (Oct 11, 2021) + +### Command Line Interface + +Meerk40t has an advanced internal console system allowing access to most parts of the code with various commands. It also provides a command line interface which should allow you to automate any processes. To learn more, download a version of Meerk40t for your platform, and execute it in a terminal with the ``--help`` argument to get a list of options. + +## Compiling from source Alternatively you can run MeerK40t directly from Python. `pip install meerk40t[all]` with python installed will usually be sufficient. Then merely run `meerk40t` at the command line. See [Install: Source wiki page](https://github.com/meerk40t/meerk40t/wiki/Install:-Source) -### GUI -![grafik](https://github.com/user-attachments/assets/e56135a2-7b1f-44be-9761-b92931e300f6) - The wxMeerK40t is the GUI and is written in wxPython. We use AUI to allow to have a very highly configurable UI. We can easily add panes and tools and there are quite a few available already. -### Command Line Interface - -Meerk40t has an advanced internal console system allowing access to most parts of the code with various commands. It also provides a command line interface which should allow you to automate any processes. +## Screenshots +![grafik](https://github.com/user-attachments/assets/e56135a2-7b1f-44be-9761-b92931e300f6) ## Drivers @@ -30,7 +36,7 @@ Meerk40t provides a variety of drivers with an extensible framework to provide s ### Supported devices * Lihuiyu M2/M3-Nano -* GRBL +* Any GRBL device (Longer, Creality, etc...) * Ezcad2-compatible JCZ controllers galvo lasers * Moshiboard * NewlyDraw System 8.1 Lasers @@ -83,16 +89,6 @@ Open source projects live and die with their support. There are a lots of ways t If you want to get into contact and help, then the [Discord Channel](https://discord.gg/vkDD3HdQq6) is the easiest and fastest way to reach out to us - we are looking forward to hear from you. -## Download -You can find and download all current and historical versions in the [Releases](https://github.com/meerk40t/meerk40t/releases) section. - -Currently, primary branches: -* 0.9 - Active - New features and some underlying architectural changes. Try the latest released version: [0.9.4](https://github.com/meerk40t/meerk40t/releases#latest) -* 0.8 - Maintenance - may receive critical bugfixes but no more new features, latest version: [0.8.12](https://github.com/meerk40t/meerk40t/releases/tag/0.8.12000) (Oct 17, 2023) -* 0.7 - Discontinued - K40 support only (including ruidacontrol emulator for 3rd party lasersoftware integration), latest version [0.7.10](https://github.com/meerk40t/meerk40t/releases/tag/0.7.10000) (June 13, 2023) -* 0.6 - Discontinued - K40 support only, latest version: [0.6.24](https://github.com/meerk40t/meerk40t/releases/tag/0.6.24) (Oct 11, 2021) - -Just download one of the files for Windows, Mac OSX, Linux and Raspberry Pi. ## Lightburn integration Meerk40t allows to act as an intermediary between your K40 laser and software that supports Ruida-controlled laser equipment - [Lightburn](https://lightburnsoftware.com/) is a relevant example of such a software product. You just need to issue the command ``ruidacontrol`` in MeerK40ts console window, and you will then be able to add an emulated Ruida Laser inside Lightburn™. Laser jobs that are created inside Lightburn™ and sent to this laser will be picked up by MeerK40t and sent to your K40. See some more detailed instructions in this [video](https://www.youtube.com/watch?v=LUUfLf5Agu0). Please note `ruidacontrol` will require the DSP version of Lightburn™. (Present in all versions since 0.7) From 1eb962f103cd9fc98b5c31940efaa8dea9464768 Mon Sep 17 00:00:00 2001 From: Laserology <167719528+Laserology@users.noreply.github.com> Date: Fri, 6 Sep 2024 01:31:58 -0700 Subject: [PATCH 2/8] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 60f0df7c11..29fbc8fe45 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ # Welcome to MeerK40t! MeerK40t (pronounced MeerKat) is a built-from-the-ground-up MIT licensed open-source laser cutting software. -## Primary Goals +The primary goals of this software is simple: + + * Provide users with high quality laser control software. * Provide developers with a highly extensible platform to help further their own ideas, and provide novel work to the laser community at large. From 1a5380fc3ff9cfb8e06d8f6c5369bf4976e9fb13 Mon Sep 17 00:00:00 2001 From: Laserology <167719528+Laserology@users.noreply.github.com> Date: Fri, 6 Sep 2024 01:33:33 -0700 Subject: [PATCH 3/8] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 29fbc8fe45..d15643a83e 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,13 @@ The primary goals of this software is simple: ## Getting started To get up and running, simply download Meerk40t from [here](https://github.com/meerk40t/meerk40t/releases) for your specific platform. (Windows, Mac OSX, Linux, and by extension, Raspberry Pi). + ### Release versions: > * 0.9 - Active - New features and some underlying architectural changes. Try the latest released version: [0.9.4](https://github.com/meerk40t/meerk40t/releases#latest) > * 0.8 - Maintenance - may receive critical bugfixes but no more new features, latest version: [0.8.12](https://github.com/meerk40t/meerk40t/releases/tag/0.8.12000) (Oct 17, 2023) > * 0.7 - Discontinued - K40 support only (including ruidacontrol emulator for 3rd party lasersoftware integration), latest version [0.7.10](https://github.com/meerk40t/meerk40t/releases/tag/0.7.10000) (June 13, 2023) > * 0.6 - Discontinued - K40 support only, latest version: [0.6.24](https://github.com/meerk40t/meerk40t/releases/tag/0.6.24) (Oct 11, 2021) + ### Command Line Interface From f3ccee044410d1c418f33cf32a6a33bea06870c8 Mon Sep 17 00:00:00 2001 From: Laserology <167719528+Laserology@users.noreply.github.com> Date: Fri, 6 Sep 2024 01:33:55 -0700 Subject: [PATCH 4/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d15643a83e..4121e07189 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ To get up and running, simply download Meerk40t from [here](https://github.com/m > * 0.8 - Maintenance - may receive critical bugfixes but no more new features, latest version: [0.8.12](https://github.com/meerk40t/meerk40t/releases/tag/0.8.12000) (Oct 17, 2023) > * 0.7 - Discontinued - K40 support only (including ruidacontrol emulator for 3rd party lasersoftware integration), latest version [0.7.10](https://github.com/meerk40t/meerk40t/releases/tag/0.7.10000) (June 13, 2023) > * 0.6 - Discontinued - K40 support only, latest version: [0.6.24](https://github.com/meerk40t/meerk40t/releases/tag/0.6.24) (Oct 11, 2021) - + ### Command Line Interface From 4793358b7403f1832520eae30f053cf73c00587c Mon Sep 17 00:00:00 2001 From: Laserology <167719528+Laserology@users.noreply.github.com> Date: Fri, 6 Sep 2024 01:35:08 -0700 Subject: [PATCH 5/8] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4121e07189..bc2d431f4a 100644 --- a/README.md +++ b/README.md @@ -10,13 +10,13 @@ The primary goals of this software is simple: ## Getting started To get up and running, simply download Meerk40t from [here](https://github.com/meerk40t/meerk40t/releases) for your specific platform. (Windows, Mac OSX, Linux, and by extension, Raspberry Pi). - +
### Release versions: > * 0.9 - Active - New features and some underlying architectural changes. Try the latest released version: [0.9.4](https://github.com/meerk40t/meerk40t/releases#latest) > * 0.8 - Maintenance - may receive critical bugfixes but no more new features, latest version: [0.8.12](https://github.com/meerk40t/meerk40t/releases/tag/0.8.12000) (Oct 17, 2023) > * 0.7 - Discontinued - K40 support only (including ruidacontrol emulator for 3rd party lasersoftware integration), latest version [0.7.10](https://github.com/meerk40t/meerk40t/releases/tag/0.7.10000) (June 13, 2023) > * 0.6 - Discontinued - K40 support only, latest version: [0.6.24](https://github.com/meerk40t/meerk40t/releases/tag/0.6.24) (Oct 11, 2021) -
 + ### Command Line Interface From 584d715949168ded24b1a3e70f399c35e3a22b89 Mon Sep 17 00:00:00 2001 From: Laserology <167719528+Laserology@users.noreply.github.com> Date: Fri, 6 Sep 2024 01:36:19 -0700 Subject: [PATCH 6/8] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index bc2d431f4a..cb18173a46 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ The primary goals of this software is simple: To get up and running, simply download Meerk40t from [here](https://github.com/meerk40t/meerk40t/releases) for your specific platform. (Windows, Mac OSX, Linux, and by extension, Raspberry Pi).
+Release Versions (Just use the latest) ### Release versions: > * 0.9 - Active - New features and some underlying architectural changes. Try the latest released version: [0.9.4](https://github.com/meerk40t/meerk40t/releases#latest) > * 0.8 - Maintenance - may receive critical bugfixes but no more new features, latest version: [0.8.12](https://github.com/meerk40t/meerk40t/releases/tag/0.8.12000) (Oct 17, 2023) From df5209aab2d90532dd0a1735cb5f98ea678f6aa0 Mon Sep 17 00:00:00 2001 From: Laserology <167719528+Laserology@users.noreply.github.com> Date: Fri, 6 Sep 2024 01:37:53 -0700 Subject: [PATCH 7/8] Update README.md --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cb18173a46..0b5cc0343b 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,14 @@ To get up and running, simply download Meerk40t from [here](https://github.com/m
Release Versions (Just use the latest) -### Release versions: + + > * 0.9 - Active - New features and some underlying architectural changes. Try the latest released version: [0.9.4](https://github.com/meerk40t/meerk40t/releases#latest) > * 0.8 - Maintenance - may receive critical bugfixes but no more new features, latest version: [0.8.12](https://github.com/meerk40t/meerk40t/releases/tag/0.8.12000) (Oct 17, 2023) > * 0.7 - Discontinued - K40 support only (including ruidacontrol emulator for 3rd party lasersoftware integration), latest version [0.7.10](https://github.com/meerk40t/meerk40t/releases/tag/0.7.10000) (June 13, 2023) > * 0.6 - Discontinued - K40 support only, latest version: [0.6.24](https://github.com/meerk40t/meerk40t/releases/tag/0.6.24) (Oct 11, 2021) + +
### Command Line Interface From 9388e17236cd9af1fd8736469c2e0e5717e50fb4 Mon Sep 17 00:00:00 2001 From: Laserology <167719528+Laserology@users.noreply.github.com> Date: Fri, 6 Sep 2024 01:39:25 -0700 Subject: [PATCH 8/8] Update README.md --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 0b5cc0343b..bcb6ac555b 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,9 @@ Meerk40t provides a variety of drivers with an extensible framework to provide s * NewlyDraw System 8.1 Lasers * Ruida-Emulation (Middleman between Lightburn and K40) +
+More device support info + ### Lihuiyu M2-Nano/M3-Nano For the Lihuiyu (stock driver), Meerk40t supports both the windows and libusb connection methods, making it compatible with Whisperer and with the original Chinese software. So MeerK40t can usually run alongside these other pieces of software interchangeably. @@ -69,6 +72,8 @@ The support for old moshiboards makes meerk40t the only known opensource softwar HPGL-modified laser systems produced under many different company names +
+ ## Support The primary source for help and documentation is the [MeerK40t Wiki - please click here](https://github.com/meerk40t/meerk40t/wiki).