diff --git a/README.md b/README.md index 90ddc43..77e1b17 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,33 @@ -[![CMake and CTest on ubuntu-latest](https://github.com/314rs/cpp_cross_plattform_template_study/actions/workflows/cmake-ubuntu-latest.yml/badge.svg?branch=main)](https://github.com/314rs/cpp_cross_plattform_template_study/actions/workflows/cmake-ubuntu-latest.yml) -# C++ cross-plattform template - -with: -- cmake -- conan -- doxygen -- github actions +[![CMake and CTest on ubuntu-latest](https://github.com/314rs/lpkf91s/actions/workflows/cmake-ubuntu-latest.yml/badge.svg)](https://github.com/314rs/lpkf91s/actions/workflows/cmake-ubuntu-latest.yml) +# LPKF91s tooling - gcode to hpgl converter + +This project features some helper programs to revive the LPKF91s PCB mill. + +The individual components are: +- __gcode2hpgl__: a converter from gcode to hpgl. (cli, gui) +- __hpgl2serial__: send a hpgl file to the PCB mill via a serial port. (cli, gui) +- a manual hpgl sender (gui) + +## Download +Download the program for your platform from the releases + + +## Build yourself +### Dependencies +- CMake +- conan package manager +- WxWidgets +- boost (asio, program_options) + +### Build +```bash +conan install conanfile.txt --build=missing +``` + +```bash +cmake +``` + ## Commands