From 2976523c11f102fdf468ad6c74ca6c4f5594e46c Mon Sep 17 00:00:00 2001
From: binaryDiv <lexi@binarydiv.dev>
Date: Sun, 18 Feb 2024 16:59:07 +0100
Subject: [PATCH] Add initial README and gitignore files

---
 .gitignore | 24 ++++++++++++++++++++++++
 README.md  | 21 +++++++++++++++++++--
 2 files changed, 43 insertions(+), 2 deletions(-)
 create mode 100644 .gitignore

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..ee9c3d9
--- /dev/null
+++ b/.gitignore
@@ -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
diff --git a/README.md b/README.md
index 2d63f6a..127fbb2 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,20 @@
-# eepyPad
+# The eepyPad
 
-Custom macro key pad with mechanical low-profile (Choc) switches. 
\ No newline at end of file
+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/)