summaryrefslogtreecommitdiff
path: root/keyboards/lz/erghost/readme.md
diff options
context:
space:
mode:
authormechlovin <57231893+mechlovin@users.noreply.github.com>2021-12-25 08:47:35 +0700
committerGitHub <noreply@github.com>2021-12-24 17:47:35 -0800
commit94fe31609e41902c0cf579f2d2601ad8b54c5d3f (patch)
treef8faba00cc7feaa999009ae05ab09f6e21a24d45 /keyboards/lz/erghost/readme.md
parente1303a30d23e6ffb782d76cada2c144c2094f1f7 (diff)
[Keyboard] Add LZ erGhost (#15451)
Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/lz/erghost/readme.md')
-rw-r--r--keyboards/lz/erghost/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/lz/erghost/readme.md b/keyboards/lz/erghost/readme.md
new file mode 100644
index 0000000000..8a48d912d0
--- /dev/null
+++ b/keyboards/lz/erghost/readme.md
@@ -0,0 +1,27 @@
+# erGhost
+
+![erGhost](https://i.imgur.com/7cUHEXTl.jpeg)
+
+LZ erGhost PCB
+
+* Keyboard Maintainer: [Mechlovin](https://github.com/mechlovin)
+* Hardware Supported: erGhost PCB, Atmega32u4
+* Hardware Availability: [GB](https://geekhack.org/index.php?topic=115100.0)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make lz/erghost:default
+
+Flashing example for this keyboard:
+
+ make lz/erghost:default:flash
+
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available
+* **Physical reset button**: Press the button on the back of the PCB \ No newline at end of file