b7368e8202
docs: Add overview of development environment
...
Give an overview of the different tools required for development and
what they're used for.
Signed-off-by: Tim Crawford <tcrawford@system76.com >
2021-06-10 09:41:16 -06:00
5a7fd2d7b3
docs: Rewrite the keyboard layout doc
...
Use of shorter sentences should reduce cognitive load. Example shell
commands should improve understanding of the description.
Signed-off-by: Tim Crawford <tcrawford@system76.com >
2021-06-08 11:23:44 -06:00
dab3a24fcb
docs: flashing: Emphasize potential loss of data
...
Internal flashing can result in corrupted or lost OS data. Make this
more explicit for internal flashing, and make it a point for external
flashing.
Signed-off-by: Tim Crawford <tcrawford@system76.com >
2021-06-08 11:23:44 -06:00
ca09e86987
Update documentation
2021-06-04 16:22:10 -06:00
7888f214bb
Update dependency and keyboard config instructions
...
People who are just reading the keyboard customization instructions might overread the dependencies installations sections.
Additionally, installing rustup for the first time requires sourcing cargo's env vars in case the firmware is flashed in the same shell session after installing rustup.
2021-05-03 16:25:19 -06:00
4ba943e3df
oryp7
2021-02-22 10:05:52 -07:00
791b3224f9
docs: Explicitly mention to use a USB cable
...
Replace the vague step about grounding with one that says to connect a
USB cable and explain its purpose.
2021-02-18 08:37:53 -07:00
2a56a82164
Add instructions for using released firmware version.
...
This should hopefully help people avoid issues like #132
2020-12-06 08:03:07 -07:00
f0f4797330
Typo: "not be be provided" -> "not be provided"
...
Deleted a duplicate word
2020-10-02 09:55:56 +02:00
def5821b01
docs: Add notes for porting a new board
2020-09-15 12:03:13 -06:00
76edf9e7a4
docs: Add note about system reset for internal flashing
2020-08-19 15:07:42 -06:00
69d3b9d8bf
docs: Move controller info to a separate file
2020-08-13 11:16:40 -06:00
d44d5229ae
docs: Move flashing to a separate file
2020-08-13 11:16:40 -06:00
2414476a66
docs: Move Mega 2560 information to separate file
...
Make a more comprehensive document describing the Mega 2560 and FPC
breakout board.
2020-08-13 11:16:40 -06:00
e3686e025b
docs: Update Makefile name
...
Debug settings were moved to `common.mk` during code reorganization.
`PARPORT` was renamed `PARALLEL`.
2020-07-23 13:43:01 -06:00
769064e1d6
docs: Add I2C pins for more models
2020-07-23 13:43:01 -06:00
aa69bd6939
Update keyboard layout doc with suggested changes
2020-06-29 14:10:55 -06:00
0e20b71702
Apply suggestions from code review
...
Co-authored-by: Jacob Floyd <cognifloyd@gmail.com >
2020-06-29 07:53:55 -06:00
7d558479a3
Improve keyboard layout customization doc
2020-06-26 16:37:34 -06:00
43b5e3a451
Add more to the keyboard customization doc (still a WIP)
2020-06-24 20:49:38 -06:00
3c2d1690df
Add my layout, enable media next/prev hotkeys, and start doc
2020-06-24 20:14:29 -06:00
3c8e511018
docs: debugging: Use console_external command
2020-06-19 15:26:55 -06:00
f9a775e71b
docs: Add info for logging through parport
2020-03-06 11:16:04 -07:00
f61e44dc21
docs: Add documentation for debugging
...
Add the steps required to wire a supported laptop for EC debugging,
along with setting up an environment to receive EC logs.
2020-02-21 12:47:53 -07:00
b04352cb63
Reorganize to allow compiling and running AVR firmware
2019-09-29 17:13:31 -06:00
