qmk_firmware/keyboards/enviousdesign/delirium/readme.md
EnviousData 391c0428c9
[Keyboard] Add support for EnviousDesign keyboards (#17544)
* Add support for Envious.Design Keyboards

Add various RP2040 keyboards I've designed.

* Fixed missing newlines at EOF.

* Ran CLANG-FORMAT and sorted out any potential issues.

* Gave keyboards all unique product IDs

* Made requested changes.

* removed all VIAL related code
* sorted out license on all *.h or *.h  files
* removed outdated RESET Keycode

* missed some VIAL bits

* Made suggested changes

* Made Suggested Changes

* missed one file to change.

* Attempted fix of CI issues

* Update .gitmodules

* Revert "Update .gitmodules"

This reverts commit f4bace51621ed0c5bd40c729fa1c6339f665f0b7.

* hopefully fixed all CI and QMK lint issues

* resolve more CI errors and a couple typos

* fixed last remaining issue as of now

* made requested changes

* further more on suggested change

* Delete README.md

* derpy workaround to change case of readme

* finished up 65M firmware

via does not work, I will investigate another time.

* re-did a lot of 65M firmware bits, also fixed via for this board

* corrected mistake in firmware

* made suggested change to info.json for 65m/60F

* finished 65M non via keymap and re-sorted via keymap

* Update keyboards/enviousdesign/tkl/rgb/keymaps/default/keymap.c

* Update keyboards/enviousdesign/tkl/rgb/keymaps/default/keymap.c

* Apply suggestions from code review

Verified updated Info.json works for aforementioned keyboards,

* Follow-up commit with aforementioned suggested changes

* Apply suggestions from code review

correction to a couple typos pointed out.

* follow-up removed some un-needed Readmes and corrected a mistake in 60F via keymap

* Apply suggestions from code review

* Added images of PCB to each Keyboard README

* Apply suggestions from code review

* Update keyboards/enviousdesign/60f/readme.md

* Added missing aspects of info.json and corrected RGB_DI_PIN to WS2812_DI_PIN in RGB keyboard

* made requested changes

* Update config.h

* used QMK migrate to update info.json

* Apply suggestions from code review

* Update keyboards/enviousdesign/65m/info.json

* renamed named keyboards as suggested and added commission keyboard to repo

* renamed file to hopefully please lint

* renamed things to be all lower case since lint doesn't appear to look for upper case

* updated keymap.c and removed unnecessary file

* fixed readme and a couple other bits

* converted various aspects to json information

* attempt fix for lint error

* fix some issues I overlooked

* Apply suggestions from code review

* moved some folders about as suggested

* Made suggested changes

* Apply suggestions from code review

* removed outdated config.h

* fixed errors in 65M and mini1800

* Apply suggestions from code review

* Update keyboards/enviousdesign/delirium/rev1/info.json

* Update keyboards/enviousdesign/65m/info.json

* Apply suggestions from code review
2023-10-12 14:07:42 -07:00

33 lines
1.8 KiB
Markdown

# EnvKB DELIRIUM
![Image of EnvKB TKL PCB](https://i.imgur.com/a7UaS4mh.png)
A low cost standard TKL design which takes inspiration from the CFTKB Mysterium. All versions are designed for reference Pi Picos.
* Keyboard Maintainer: [Envious-Data](https://github.com/envious-data)
* Hardware Supported:
* Delirium Prototype (`tkl/rev0`)
* Delirium (`tkl/rev1`)
* Delirium RGB (`tkl/rgb`)
* Hardware Availability: [Mechboards](https://mechboards.co.uk/products/envkb-delirium-tkl-kit), [GitHub](https://github.com/Envious-Data/Env-KB)
Make example for this keyboard (after setting up your build environment):
make enviousdesign/tkl/rgb:default
Flashing example for this keyboard:
make enviousdesign/tkl/rgb: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 top left key and plug in the keyboard. This will also clear the emulated EEPROM, so it is a good first step if the keyboard is misbehaving.
* **Physical reset**: Hold down the `BOOTSEL` button on the Pi Pico, then either plug the board in or press the `RESET` button.
* **Keycode in layout**: Press the key mapped to `QK_BOOT`. In the pre-supplied keymaps it is on the second layer, replacing the Esc key.
After entering the bootloader through one of the three methods above, the keyboard will appear as a USB mass storage device named `RPI-RP2`. If the CLI is unable to find this device, the compiled `.uf2` file can be manually copied to it. The keyboard will reboot on completion with the new firmware loaded.