diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5ee612d --- /dev/null +++ b/.gitignore @@ -0,0 +1,21 @@ +# IDEs / editors +.idea +.vscode +.*.swp + +# General +/tmp +/_tmp +.DS_STORE +*_bak +*_bak[0-9] + +# Node +.npm +node_modules +dist + +# 3D modeling temporary files +*.FCStd1 +*.3mf +*.gcode diff --git a/README.md b/README.md index 13a6343..3d793e9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ -# eepyBoard +# The eepyBoard -Custom ergonomic mechanical keyboard with low-profile (Choc) switches. \ No newline at end of file +Custom ergonomic mechanical keyboard with low-profile (Choc) switches. + +## Repository structure + +- `/layouts`: Keyboard layouts created with the [Keyboard Layout Editor](http://www.keyboard-layout-editor.com) +- `/ergogen`: [Ergogen](https://docs.ergogen.xyz/) files to generate outlines, cases and PCBs + +## Used software + +- [Keyboard Layout Editor](http://www.keyboard-layout-editor.com) +- [Ergogen](https://docs.ergogen.xyz/), [unofficial Ergogen web UI](https://ergogen.cache.works/) +- [KiCad](https://www.kicad.org/) +- [FreeCAD](https://www.freecad.org/) +- [UltiMaker Cura](https://ultimaker.com/software/ultimaker-cura/)