diff --git a/README.md b/README.md index 6696353..b50ac86 100644 --- a/README.md +++ b/README.md @@ -38,3 +38,24 @@ DIY Open Source Braille embosser [![Documentation Status](https://readthedocs.org/projects/braillerap-en/badge/?version=latest&style=plastic)](https://braillerap-en.readthedocs.io/en/latest/index.html) The full documentation [is available at braillerap-en.readthedocs.io](https://braillerap-en.readthedocs.io/en/latest/index.html). + +## Repository Structure + +### `docs/` +The source file for readthedoc documentation, viewable at [braillerap.readthedocs.io](https://braillerap.readthedocs.io/fr/latest/index.html). + +### `lasercut/` +SVG/DXF file for laser cut + +### `MarlinBraille/` +BrailleRAP Firmware for MKS GEN 1.4 & MKS GEN L 2.1. + +The firmware is already configured for DRV8825 stepper drivers. + +### `printed_parts/` +STL files for 3D printed parts. + +There is an xlsx (3D printed parts excel board.xlsx) files that detail the parts to print. + +### `NatBrailleTools/` +Java source code for NatBraille BrailleRAP driver. This is a little obsolete now. Consider using AccessBrailleRAP (https://github.com/braillerap/AccessBrailleRAP) instead. diff --git a/README2.md b/README2.md deleted file mode 100644 index 0d1e33f..0000000 --- a/README2.md +++ /dev/null @@ -1,17 +0,0 @@ -## Directories -### docs -The source file for readthedoc documentation - -### lasertcut -SVG/DXF file for laser cut - -### MarlinBraille -BrailleRAP Firmware for MKS GEN 1.4 & MKS GEN L 2.1. -The firmware is already configurated for DRV8825 stepper drivers. - -### printed_parts -STL files for 3D printed parts. -There is an xlsx (3D printed parts excel board.xlsx) files that detail the parts to print. - -### NatBrailleTools -Java source code for NatBraille BrailleRAP driver. This is a little obsolete now, considere using AccessBrailleRAP (https://github.com/braillerap/AccessBrailleRAP) \ No newline at end of file