Add initial README and gitignore files
This commit is contained in:
parent
6ff27d3394
commit
44180b3e4c
|
|
@ -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
|
||||||
15
README.md
15
README.md
|
|
@ -1,3 +1,16 @@
|
||||||
# eepyBoard
|
# The eepyBoard
|
||||||
|
|
||||||
Custom ergonomic mechanical keyboard with low-profile (Choc) switches.
|
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/)
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue