Merge branch 'main' of https://github.com/meerk40t/meerk40t

Laserology · Sep 6, 2024 · 31e1fa5 · 31e1fa5
2 parents b7916ef + 4caabbf
commit 31e1fa5
Showing 1 changed file with 31 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -1,27 +1,41 @@
-# MeerK40t
+# 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.
 
-## 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
+<details>
+<summary>Release Versions (Just use the latest)</summary>
 
-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)
+> * 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)
 
-### 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.
+</details>
 
 ### 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.
+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)
+
+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.
+
+## Screenshots
+![grafik](https://github.com/user-attachments/assets/e56135a2-7b1f-44be-9761-b92931e300f6)
 
 ## Drivers
 
@@ -30,12 +44,15 @@ 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
 *   Ruida-Emulation (Middleman between Lightburn and K40)
 
+<details>
+<summary>More device support info</summary>
+
 ### 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.
 
@@ -55,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
 
+</details>
+
 ## Support
 The primary source for help and documentation is the [MeerK40t Wiki - please click here](https://github.com/meerk40t/meerk40t/wiki).
 
@@ -83,16 +102,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)