vmario/BrailleRap
1
0
Fork 0
mirror of https://github.com/braillerap/BrailleRap.git synced 2025-06-07 17:39:58 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4 from DeflateAwning/merge-readme-and-readme2

Browse Source 
Merge README2.md into section of README.md
This commit is contained in:
StephaneG 2024-12-15 15:02:24 +01:00 committed by GitHub
commit d3b4472e91
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 21 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -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.

17
README2.md
View File

@ -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)