diff --git a/README.md b/README.md index 2941738..ebd74ba 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,15 @@ # S4-P3-Projet PCB maker project -[![Build Status](https://travis-ci.org/marc4492/S4-P3-Projet.svg?branch=master)](https://travis-ci.org/marc4492/S4-P3-Projet) \ No newline at end of file +[![Build Status](https://travis-ci.org/marc4492/S4-P3-Projet.svg?branch=master)](https://travis-ci.org/marc4492/S4-P3-Projet) + +This is a PCB maker device, it is use to create PCB from an image in black and white. Three software are include in this repo : + - GCode Generator : + Create a GCode file form an image of the PCB + - Device communication : + Send a GCode file to the device + Manual control of the device + - GCode Interpreter : + Move motors from a GCode command + +For more documentation on each software read the README files in every directory.