Merge pull request #47 from ErinCall/guide-copy-editing

Guide: copy editing

guide/README.org

@@ -14,11 +14,11 @@
     - I ordered 70 Cherry MX Whites from here:
       https://mechanicalkeyboards.com/shop/index.php?l=product_detail&p=847
   - Decide on the key caps
-    - On the glamour-Shot you can see the 1976 keycap set, it used to be sold over here:
+    - On the glamour shot you can see the 1976 keycap set; it used to be sold over here:
       http://pimpmykeyboard.com/sa-1976-keycap-set/ but the link is dead right now. You could
       try this link: https://www.massdrop.com/buy/nineteenseventysix-sa-keycap-set but it is a
       massdrop which is way different from usual online-stores. If you find a site that sells
-      these make sure you get the right amount and type of keys according to the layout
+      these, make sure you get the right amount and type of keys according to the layout.
     - I got the "TKL Base Set + TKL Modifier" from over here:
       http://pimpmykeyboard.com/dsa-pbt-abs-blank-keycap-sets/ but I'm still two long keys
       short, I will have to order those specifically and I have a bunch of keys I don't use
@@ -57,7 +57,7 @@
   - All the resistors used for free (5 resistors are used)
   - Several files for working out the rough edges of the 3D-printout
 
-  Depending on what you have available you might spend more or less money than me, 300€ however
+  Depending on what you have available you might spend more or less money than me; however, 300€
   is a good rough estimate.
 
   After all the parts have arrived it is safe to move on to the next section.
@@ -65,29 +65,29 @@
 * Wiring
   It is assumed that you have printed the casing successfully.
 
-  1) Plug the switches into the Casing, no glue is needed, the casing provides the perfect fit.
+  1) Plug the switches into the casing. No glue is needed; the casing provides the perfect fit.
   2) Put the keycaps on the switches
-     - Note that in the pictures here some of the long keys on the thumb-part are too short,
+     - Note that in the pictures here some of the long keys on the thumb-part are too short;
-       that's why it doesnt look symmetrical
+       that's why it doesn't look symmetrical
 
   [[file:application-of-switches-and-caps.jpg]]
 
   Now going further on in the guide there are two options
-  1. The first option is to print flexible PCBs. The advantage is that you save alot of wiring
+  1. The first option is to print flexible PCBs. The advantage is that you save a lot of wiring
-     business, everything looks rather clean and you dont have to worry about your cables being too
+     business, everything looks rather clean and you don't have to worry about your cables being too
-     thick such that the casing doesnt close. However if you don't have the means to print out such
+     thick such that the casing doesn't close. However, if you don't have the means to print out such
      PCBs there is the second option, wiring everything by hand.
-     - The guide for this PCB-option is very rough indeed and it doesnt include the firmware
+     - The guide for this PCB-option is very rough indeed and it doesn't include the firmware
-       used. Wiring and firmware play extremely close together, wiring before knowing your
+       used. Wiring and firmware play extremely close together--wiring before knowing your
-       firmware is like buying a shoe without measuring your feet before. For this option
+       firmware is like buying a shoe without measuring your feet before. For this option,
        information about the exact firmware is not published, this in addition to the fact that
        the pictures in this rough guide are incomplete makes this option extremely
        beginner-unfriendly. Going in blind-sided like this may lead to one of these things:
-       1. reprogramming huge parts of the firmware to match your wiring which comes with a ton of
+       1. reprogramming huge parts of the firmware to match your wiring, which comes with a ton of
-          debugging
+          debugging.
-       2. rewiring to adapt to what the firmware expects, which may easily double your work here
+       2. rewiring to adapt to what the firmware expects, which may easily double your work here.
      - [[Route 1: Dactyl Flexible PCB Rough Guide]]
-  2. The second option is to hand-wire everything. For people like me who had never soldered before
+  2. The second option is to hand-wire everything. For people like me, who had never soldered before,
      this was great pain and pleasure.
      - Here too firmware and wiring go hand in hand, you pretty much have to have a detailed look
        at the firmware you are using before wiring anything. I provide my modification of the
@@ -95,13 +95,13 @@
        - TODO: Make a successfull pull-request, such that it is available in the official
          ergodox-firmware
      - Some of the steps of this guide may not be described in much detail, but in contrast to
-       option one there is a whole lot more of information.
+       option one there is a whole lot more information.
      - [[Route 2: Dactyl Hand-Wiring Guide]]
 
 ** Route 1: Dactyl Flexible PCB Rough Guide
    [[workbench.jpg]]
 
-   For now, take a look at the images and try to figure things out, I know that's not great (it's
+   For now, take a look at the images and try to figure things out; I know that's not great (it's
    better than nothing!)
 
 *** Making the PCB
@@ -109,11 +109,10 @@
     you would a usual PCB
 
     #+BEGIN_QUOTE
-    NOTE: If you only have an Inkjet make photocopies of the print out,
+    NOTE: If you only have an Inkjet make photocopies of the print out. Voilà, Toner based copies!
-    voilà Toner based copies!
     #+END_QUOTE
 
-    [[http://www.instructables.com/id/Toner-transfer-no-soak-high-quality-double-sided/][Here'sa handy toner transfer guide ...]]
+    [[http://www.instructables.com/id/Toner-transfer-no-soak-high-quality-double-sided/][Here's a handy toner transfer guide ...]]
 
     Print these PCB designs out...
 
@@ -159,13 +158,12 @@
 
     [[hotglue-left-hand.jpg]]
 
-    That's all for now, this guide will improve over time! (TODO!)
 ** Route 2: Dactyl Hand-Wiring Guide
 *** Step 1: Creating the rows
     Using the copper wire you solder each row together, notice how the thumb-part gets its own
     row. If you take a close look you can see how I did do a messy job soldering, I had to redo
-    some of the parts because they weren't soldered properly. Do this for both sides. Which ones
+    some of the parts because they weren't soldered properly. Do this for both sides. It doesn't
-    of the two available pins of each switch you chose for the row doesnt matter, but for it to
+    matter which of the two available pins of each switch you chose for the row, but for it to
     look clean you should decide for either one of them.
 
     [[file:wiring_create_rows.jpg]]
@@ -190,9 +188,9 @@
     want to wire the diodes in the according way (check whether the tmk_keyboard firmware expects
     a row-driven or a column-driven setup).
 
-    As you can see in these following pictures I went for the "row-driven" setup (visible by the
+    As you can see in these following pictures, I went for the "row-driven" setup (visible by the
     direction of the diodes, the black line being towards the key-switches). This first picture
-    doesnt show how the 6 thumb-keys are actually individually connected to the 6 main columns,
+    doesn't show how the 6 thumb-keys are actually individually connected to the 6 main columns,
     but note the small black line on each diode.
 
     [[file:wiring-create-columns-left.jpg]]
@@ -201,7 +199,7 @@
 
     [[file:wiring-create-columns-right.jpg]]
 
-    How Thumb-keys are wired again depends on the firmware, the following picture shows the wiring
+    How thumb-keys are wired again depends on the firmware. The following picture shows the wiring
     of the thumb keys more clearly and also the part in the code that reflects this wiring
     (ergodox-firmware/src/keyboard/dactyl/matrix.h).
 
@@ -209,25 +207,25 @@
 
 *** Step 3: Put the Teensy and the MCP in place
     This next step is to wire the Teensy 2.0 and the MCP 23018 in place.
-    Everything necessary for that really is the following circuit diagram
+    Everything necessary for that really is the following circuit diagram.
 
     [[file:circuit-diagram.png]]
 
     Things to note here:
     - The columns for the MCP go from 0 to 6, the columns for the Teensy go from 7 to D (counting
-      in hexadecimal) which makes great sence, since the MCP is left to the Teensy and we read from
+      in hexadecimal) which makes great sense, since the MCP is to the left of the Teensy and we
-      left to right.
+      read from left to right.
     - When debugging this and using the ergodox-firmware, both sides have to be wired completely
-      and actually with the TRRS connected, dont expect the keyboard to work before that. The reason being is how
+      and actually with the TRRS connected. Don't expect the keyboard to work before that. The
-      the ergodox-firmware stops completely if either the Teensy or the MCP weren't initiated
+      reason is that the ergodox-firmware stops completely if either the Teensy or the MCP weren't
-      properly.
+      initiated properly.
-    - The LEDs are handy for debugging, definitely go ahead and connect those. When the keyboard
+    - The LEDs are handy for debugging; definitely go ahead and connect those. When the keyboard
       starts successfully two of the LEDs light up shortly.
     - From the Teensy over to the MCP go exactly 4 connections. The blue, the red and the two green
       ones. This is done using the TRRS jacks and cable.
-    - Yes, the connection from B4 to VCC doesnt seem to make any sense, but the B4 port actually
+    - Yes, the connection from B4 to VCC doesn't seem to make any sense, but the B4 port actually
       gets used directly in the ergodox-firmware, so just connect those connections that make no
-      sense on first sight and either dont question it or find out why this is necessary by going
+      sense on first sight and either don't question it or find out why this is necessary by going
       through the firmware in great detail.
 
     This is how the trrs jacks are wired: