Skip to content

Commit

Permalink
Fixing capitalization
Browse files Browse the repository at this point in the history
  • Loading branch information
Marco Pelegrini committed Nov 27, 2024
1 parent e3ddd88 commit f154cda
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 16 deletions.
23 changes: 11 additions & 12 deletions _sites/marcopad.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Marcopad
title: MarcoPad
index: 1
description: A compact 3x3 keys macropad built with RP-2040 Zero
---
Expand All @@ -11,13 +11,13 @@ description: A compact 3x3 keys macropad built with RP-2040 Zero
<h2>Introduction</h2>
<div class="flex-container">
<div class="flex-item-left">
<p>The Marcopad - <i>a word play with my name, Marco</i> - is a compact 3x3 keys macropad built with RP-2040 Zero</p>
<p>The MarcoPad is a compact 3x3 keys macropad built with RP-2040 Zero</p>
<p>It's built using the <a href="https://www.waveshare.com/wiki/RP2040-Zero">RP-2040 Zero</a> as MCU, <a href="https://keebd.com/en-ca/collections/choc-switches">Choc</a> mechanical keyboard switches, <a href="https://www.adafruit.com/product/4960">SK6812 MINI-E RGB</a> LEDs for backliting (optional) and simple discrete electronic components.</p>
<p>The original design is composed of a 3D printed base, a custom PCB, a laser-cut acrylic faceplate, and laser-cut acrylic keycaps.</p>
<p>The excellent <a href="https://qmk.fm/">QMK Firmware</a> is used to control the function keys and the backlight.</p>
</div>
<div class="flex-item-right">
<img src="{{ 'assets/img/marcopad/hardware/macropad.png' | relative_url }}" alt="Marcopad PCB Mounted" title="Marcopad PCB Mounted">
<img src="{{ 'assets/img/marcopad/hardware/macropad.png' | relative_url }}" alt="MarcoPad" title="MarcoPad">
</div>
</div>
</article>
Expand All @@ -42,7 +42,7 @@ description: A compact 3x3 keys macropad built with RP-2040 Zero
</ul>
</div>
<div class="flex-item-right">
<img src="{{ 'assets/img/marcopad/hardware/pcb-mounted.png' | relative_url }}" alt="Marcopad PCB Mounted" title="Marcopad PCB Mounted">
<img src="{{ 'assets/img/marcopad/hardware/pcb-mounted.png' | relative_url }}" alt="MarcoPad PCB Mounted" title="MarcoPad PCB Mounted">
</div>
</div>
<h3>Base</h3>
Expand All @@ -52,7 +52,7 @@ description: A compact 3x3 keys macropad built with RP-2040 Zero
<p>Find the 3mf file <a href="">here</a>.</p>
</div>
<div class="flex-item-right">
<img src="{{ 'assets/img/marcopad/hardware/3d-pla-base.png' | relative_url }}" alt="Marcopad PCB Mounted" title="Marcopad PCB Mounted">
<img src="{{ 'assets/img/marcopad/hardware/3d-pla-base.png' | relative_url }}" alt="3D printed base" title="3D printed base">
</div>
</div>
<div class="flex-container">
Expand All @@ -62,7 +62,7 @@ description: A compact 3x3 keys macropad built with RP-2040 Zero
<p>Find the svg file <a href="">here</a>.</p>
</div>
<div class="flex-item-right">
<img src="{{ 'assets/img/marcopad/hardware/faceplate.png' | relative_url }}" alt="Marcopad PCB Mounted" title="Marcopad PCB Mounted">
<img src="{{ 'assets/img/marcopad/hardware/faceplate.png' | relative_url }}" alt="Faceplate" title="Faceplate">
</div>
</div>
<div class="flex-container">
Expand All @@ -72,7 +72,7 @@ description: A compact 3x3 keys macropad built with RP-2040 Zero
<p>For the key illustrations, I've printed images on stickers.</p>
</div>
<div class="flex-item-right">
<img src="{{ 'assets/img/marcopad/hardware/keys.png' | relative_url }}" alt="Marcopad PCB Mounted" title="Marcopad PCB Mounted">
<img src="{{ 'assets/img/marcopad/hardware/keys.png' | relative_url }}" alt="Keys" title="Keys">
</div>
</div>
</article>
Expand All @@ -82,19 +82,19 @@ description: A compact 3x3 keys macropad built with RP-2040 Zero
<article class="indented">
<h2>Software</h2>
<h3>Initial Setup</h3>
<p>The Marcopad uses the <a href="https://qmk.fm/">QMK</a> as the firmware to control the function keys and the backlit.</p>
<p>The MarcoPad uses the <a href="https://qmk.fm/">QMK</a> as the firmware to control the function keys and the backlit.</p>
<h5>Basic setup</h5>
<p>Follow <a href="https://docs.qmk.fm/newbs_getting_started">QMK's instructions</a> for Prerequisites, Preparing your environment and Setting up QMK.</p>
<h5>Entering flashing mode</h5>
<p>The first time you connect the Marcopad to your computer, your should see a volume/drive named "RPI-RP2".</p>
<p>The first time you connect the MarcoPad to your computer, your should see a volume/drive named "RPI-RP2".</p>
<p>If it's not showing up, try pressing and holding the <kbd>BOOT</kbd> button, then short press the <kbd>RESET</kbd> button on the RP2040 Zero.</p>
<p>If the issue persists, you problem might be with the hardware itself, connections or soldering. Please check everything.</p>
<h5>Flashing the firmware</h5>
<p>Once installed, go to QMK's home folder:</p>
<code>❯ qmk cd</code>
<p>Flash the firmware:</p>
<code>❯ make marcopad:default:flash</code>
<p>✅ Done, your Marcopad is ready for use.</p>
<p>✅ Done, your MarcoPad is ready for use.</p>
<p><i>By default, the keys are mapped to <kbd>1-9</kbd>, try them out to make sure everything works.</i></p>
<h3>Keymap configuration</h3>
<p>QMK is very flexible, extensible and configurable. You can explore the QMK's documentation for advanced setup.</p>
Expand All @@ -118,8 +118,7 @@ description: A compact 3x3 keys macropad built with RP-2040 Zero
<p>For instance, if you want be bottom-left key (currenty KC_P1) to function as "copy", replace <kbd>KC_P1</kbd> for <kbd>LCMD(KC_C)</kbd> on macos or <kbd>LCTL(KC_C)</kbd> on Windows. The "paste" command would be <kbd>CMD(KC_V)</kbd> on macos or <kbd>LCTL(KC_V)</kbd> on Windows.</p>
<h5>Flash your custom firmware:</h5>
<code>❯ make marcopad:[your keymap name]:flash</code>
<p>✅ Done, your Marcopad is ready for use.</p>
<p>✅ Done, your MarcoPad is ready for use.</p>
</article>
</section>
</div>

8 changes: 4 additions & 4 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ permalink: /
---

<div class="width-container">
<h2><a href="{% link _sites/marcopad.md %}">Marcopad</a></h2>
<h2><a href="{% link _sites/marcopad.md %}">MarcoPad</a></h2>
<section id="keyfeature-list">
<div class="keyfeature">
<h3>Compact 3x3 macropad for RP-2040</h3>
<p>The Marcopad - <i>a word play with my name, Marco</i> - is a compact 3x3 keys macropad built with RP-2040 Zero</p>
<a href="{% link _sites/marcopad.md %}"><img src="{{ 'assets/img/marcopad/hardware/macropad.png' | relative_url }}" alt="Marcopad PCB Mounted" title="Marcopad PCB Mounted"></a>
<p>The MarcoPad is a compact 3x3 keys macropad built with RP-2040 Zero</p>
<a href="{% link _sites/marcopad.md %}"><img src="{{ 'assets/img/marcopad/hardware/macropad.png' | relative_url }}" alt="MarcoPad" title="MarcoPad"></a>
</div>
</section>
</section>

0 comments on commit f154cda

Please sign in to comment.