Add initial README and gitignore files
This commit is contained in:
parent
25b5abc378
commit
2976523c11
|
|
@ -0,0 +1,24 @@
|
|||
# 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
|
||||
|
||||
# Ergogen
|
||||
/ergogen/output
|
||||
21
README.md
21
README.md
|
|
@ -1,3 +1,20 @@
|
|||
# eepyPad
|
||||
# The eepyPad
|
||||
|
||||
Custom macro key pad with mechanical low-profile (Choc) switches.
|
||||
Custom macro key pad with mechanical 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/)
|
||||
|
||||
## Resources
|
||||
|
||||
- [FlatFootFox's Ergogen tutorial](https://flatfootfox.com/ergogen-introduction/)
|
||||
|
|
|
|||
Loading…
Reference in New Issue