Skip to content

Commit fa544ef

Browse files
Update Getting_Started.md (#998)
* Update Getting_Started.md * Update docs/en/Getting_Started.md Co-authored-by: xs5871 <[email protected]> * Update Getting_Started.md * Remove references to BR and JA translations from README.md * Add "How to get it" to README.md * Fix spelling --------- Co-authored-by: xs5871 <[email protected]>
1 parent b57bdb2 commit fa544ef

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

docs/en/Getting_Started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Known working and recommended devices can be found in the [list of officially su
88
## TL;DR Quick start guide
99
> To infinity and beyond!
1010
1. [Install CircuitPython version 7.3 or higher on your board](https://learn.adafruit.com/welcome-to-circuitpython/installing-circuitpython). With most boards, it should be as easy as drag and dropping the firmware on the drive
11-
2. Get a [copy of KMK](https://github.com/KMKfw/kmk_firmware/archive/refs/heads/master.zip) from the master branch
11+
2. Get an up to date [copy of KMK](https://github.com/KMKfw/kmk_firmware/archive/refs/heads/main.zip) from the main branch
1212
3. Unzip it and copy the KMK folder and the boot.py file at the root of the USB drive corresponding to your board (often appearing as CIRCUITPY)
1313
4. Create a new *code.py* or *main.py* file in the same root directory (same level as boot.py) with the example content hereunder:
1414

docs/en/README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
# How to get it
2+
3+
KMK is updated often and sometimes a lot. Obtaining a fresh copy can be done by forking the `main` branch of this repository, or downloading a [snapshot](https://github.com/KMKfw/kmk_firmware/archive/refs/heads/master.zip) of it.
4+
5+
Pre-compiled version of KMK can be acquired by navigating to [Actions > Build](https://github.com/KMKfw/kmk_firmware/actions/workflows/compile.yml), there it can be found under artifacts for the latest build.
6+
17
# Documentation index
28

39
Before you look further, you probably want to start with our [getting started guide](Getting_Started.md).
@@ -49,8 +55,3 @@ Before you look further, you probably want to start with our [getting started gu
4955
- [MediaKeys](media_keys.md): Adds support for media keys such as volume
5056
- [RGB](rgb.md): RGB lighting for underglow. Will work on most matrix RGB as will be treated the same as underglow.
5157
- [Status LED](extension_statusled.md): Indicates which layer you are on with an array of single leds.
52-
53-
## Language versions
54-
55-
- [Japanese getting started](https://github.com/KMKfw/kmk_firmware/tree/master/docs/ja/Getting_Started.md)
56-
- [Brazilian Portuguese](https://github.com/KMKfw/kmk_firmware/tree/master/docs/ptBR)

0 commit comments

Comments
 (0)