summaryrefslogtreecommitdiff
path: root/keyboards/mariorion_v25/readme.md
diff options
context:
space:
mode:
authorMaria <81305596+toril940@users.noreply.github.com>2023-11-10 21:39:00 +0000
committerGitHub <noreply@github.com>2023-11-10 14:39:00 -0700
commit6876fbe51d02873ae4b63e555ac5cb0a7c36ee98 (patch)
tree894d2d1f8a3f0ed50ff11ad3cbda29fc29e954ed /keyboards/mariorion_v25/readme.md
parent38d6e9a75a4cff4ae5bd32209fc0cecb83c6f23b (diff)
[Keyboard] Add MariOrion v2.5 (#22273)
* Pushed MariOrion v2.5 to the branch. Prod and proto version added. * Pushed MariOrion v2.5 to the branch. Prod and proto version added. * Proper addition of layout options Addition of split bs rshift tsangan layout options. Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Merge branch 'toril940mariorion_v25' of github.com:toril940/qmk_firmware into toril940mariorion_v25 * Merge branch 'toril940mariorion_v25' of github.com:toril940/qmk_firmware into toril940mariorion_v25 * Update keyboards/mariorion_v25/proto/keymaps/via/keymap.c Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Update keyboards/mariorion_v25/proto/keymaps/default/keymap.c Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Updated readme.md with more information regarding make commands, and proto vs prod. * Update keyboards/mariorion_v25/prod/keymaps/via/keymap.c Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Update keyboards/mariorion_v25/prod/keymaps/default/keymap.c Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Update keyboards/mariorion_v25/prod/info.json Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Amended some changes to info.json - community layouts changed from scope to array. * Update keyboards/mariorion_v25/readme.md Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Revert keyboards/gray_studio/think65/solder/solder.c Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Revert keyboards/gray_studio/think65/solder/solder.c Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Revert keyboards/gray_studio/think65/solder/solder.c Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Removed via.json from the via keymaps. Replaced with matrix_diagram.md. via.json file moved off to [public mariorion_v25 repo](https://github.com/toril940/orion-v25) * Revert keyboards/gray_studio/think65/solder/solder.c Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Removed via.json from the via keymaps. Replaced with matrix_diagram.md. via.json file moved off to [public mariorion_v25 repo](https://github.com/toril940/orion-v25) * Update keyboards/mariorion_v25/proto/info.json Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Update keyboards/mariorion_v25/rules.mk Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Update keyboards/mariorion_v25/proto/info.json Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Update keyboards/mariorion_v25/proto/info.json Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Update keyboards/mariorion_v25/proto/info.json Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Update keyboards/mariorion_v25/prod/info.json Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Update keyboards/mariorion_v25/prod/info.json Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Update keyboards/mariorion_v25/prod/info.json Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Update keyboards/mariorion_v25/prod/info.json Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Revert keyboards/gray_studio/think65/solder/solder.c Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Update keyboards/mariorion_v25/matrix_diagram.md Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Update keyboards/mariorion_v25/readme.md Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Update keyboards/mariorion_v25/readme.md Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Update keyboards/mariorion_v25/readme.md Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Update keyboards/mariorion_v25/readme.md Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Update keyboards/mariorion_v25/readme.md Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Update keyboards/mariorion_v25/proto/mariorion_v25.c Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Update keyboards/mariorion_v25/prod/mariorion_v25.c Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Pushed new info.json and keymap.c files. * Pushed new info.json and keymap.c files. * Fixes to LED driver wrt PWM definitions with STM. * Update keyboards/mariorion_v25/prod/keymaps/via/keymap.c Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/mariorion_v25/prod/keymaps/via/keymap.c Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/mariorion_v25/prod/info.json Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/mariorion_v25/prod/mariorion_v25.c Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/mariorion_v25/proto/info.json Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/mariorion_v25/proto/config.h Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/mariorion_v25/proto/mariorion_v25.c Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/mariorion_v25/proto/mariorion_v25.c Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/mariorion_v25/proto/keymaps/via/keymap.c Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/mariorion_v25/proto/keymaps/via/keymap.c Co-authored-by: Ryan <fauxpark@gmail.com> * Committing a details update to readme.md. * Committing a details update to readme.md. * Update keyboards/mariorion_v25/prod/config.h Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/mariorion_v25/prod/mariorion_v25.c Co-authored-by: Ryan <fauxpark@gmail.com> * Revert "Committing a details update to readme.md." This reverts commit 068a82a1fcf1996d87f7f97a10e9f5fbbee79a29. * Committing a details update to readme.md. * Update keyboards/mariorion_v25/halconf.h Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/mariorion_v25/mcuconf.h Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/mariorion_v25/prod/config.h Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/mariorion_v25/proto/config.h Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/mariorion_v25/halconf.h Co-authored-by: Ryan <fauxpark@gmail.com> * Production pictures replacing the standard ones in the readme.md :) * waffle87 requests bundled: - Licence headers added - Codeblocked matrix_diagram.md - Consolidated files where possible - Removed excess from config.h --------- Co-authored-by: toril940 <anastasialucas940@hotmail.com> Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/mariorion_v25/readme.md')
-rw-r--r--keyboards/mariorion_v25/readme.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/keyboards/mariorion_v25/readme.md b/keyboards/mariorion_v25/readme.md
new file mode 100644
index 0000000000..13f2f9dc2a
--- /dev/null
+++ b/keyboards/mariorion_v25/readme.md
@@ -0,0 +1,36 @@
+# MariOrion v2.5
+
+![mariorion_v25_1](https://i.imgur.com/PFb6AGo.jpg)
+![mariorion_v25_2](https://i.imgur.com/Fgdm2fx.jpg)
+
+This project was a revival of the Duck Orion v2.5, where we don't have very many PCBs with modern features, and
+especially Alps support as well. This PCB has both Alps and MX support as well as universal layout support! It also
+features a 3u/1u/3u split spacebar variant for fun :)
+
+The prototype version is for use only by Maria, and it's the r0 run in essence. Please do use prod unless otherwise
+stated (prod me if you're confused, @mawiaa on Discord)!
+
+* Keyboard Maintainer: [Maria](https://github.com/toril940)
+* Hardware Supported: MariOrion v2.5 PCB
+* Hardware Availability: Link coming soon, through Hineybush :)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make mariorion_v25/prod:default
+ make mariorion_v25/proto:default
+
+Flashing example for this keyboard:
+
+ make mariorion_v25/prod:default:flash
+ make mariorion_v25/proto: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
+* **Physical reset button**: Hold the reset button on the back of the PCB for 4-10 seconds or so -
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available