Skip to content

Commit e4f9774

Browse files
zvecrjgbowser
andauthoredOct 18, 2021
Update README to reflect new packaging (#67)
* Update README to reflect new packaging * code blocks * Update README.md Co-authored-by: John Bowser <66637570+jgbowser@users.noreply.github.com> Co-authored-by: John Bowser <66637570+jgbowser@users.noreply.github.com>
1 parent 0501d04 commit e4f9774

File tree

1 file changed

+25
-20
lines changed

1 file changed

+25
-20
lines changed
 

‎README.md

+25-20
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,17 @@
44

55
2. Plug in your keyboard.
66

7-
3. In your terminal, change to the directory where you downloaded the executable and applet-*.bin file(s).
7+
3. In your terminal, change to the directory where you downloaded the executable file.
88

9-
4. **Windows** - Run `mdloader_windows.exe --first --download FILE_NAME --restart`. Replace "FILE_NAME" with the filename of your compiled firmware.
10-
**Linux** - Run `mdloader_linux --first --download FILE_NAME --restart`. Replace "FILE_NAME" with the filename of your compiled firmware. Depending on your user's permissions, you might have to add your user to the `dialout` group or use `sudo` on the command.
11-
**Mac** - Run `mdloader_mac --first --download FILE_NAME --restart`. If you downloaded with Mac Safari, run `mdloader_mac.dms --first --download FILE_NAME --restart`. Replace "FILE_NAME" with the filename of your compiled firmware.
12-
13-
5. You should see the message:
9+
4. Run the following command:
1410
```
15-
Scanning for device for 60 seconds
11+
./mdloader --first --download FILE_NAME --restart
12+
```
13+
**Note**: Replace `FILE_NAME` with the filename of your compiled firmware.
14+
15+
5. You should see the message:
16+
```
17+
Scanning for device for 60 seconds
1618
.....
1719
```
1820

@@ -25,7 +27,6 @@ Device port: /dev/cu.usbmodem234431 (SAMD51J18A)
2527
Opening port '/dev/cu.usbmodem234431'... Success!
2628
Found MCU: SAMD51J18A
2729
Bootloader version: v2.18Sep 4 2018 16:48:28
28-
Applet file: applet-flash-samd51j18a.bin
2930
Applet Version: 1
3031
Writing firmware... Complete!
3132
Booting device... Success!
@@ -42,23 +43,23 @@ Massdrop Loader is used to read firmware from and write firmware to Massdrop key
4243

4344
## Supported operating systems
4445

45-
Windows XP or greater (32-bit and 64-bit versions, USB Serial driver in drv_win folder)
46-
Linux x86 (32-bit and 64-bit versions)
47-
Mac OS X
46+
- Windows XP or greater (32-bit and 64-bit versions, USB Serial driver in drv_win folder)
47+
- Linux x86 (32-bit and 64-bit versions)
48+
- Mac OS X
4849

4950
## Supported devices
5051

5152
Massdrop keyboard's featuring Microchip's SAM-BA bootloader.
5253

5354
## Building
5455

55-
Enter mdloader directory where Makefile is located and excute:
56+
Enter mdloader directory where Makefile is located and execute:
5657

57-
`make`
58+
```
59+
make
60+
```
5861

59-
This will create a `build` directory with the compiled executable and required applet-*.bin files.
60-
Run `./build/mdloader` to test.
61-
Note that the target MCU applet file must exist in the directory the executable is called from.
62+
This will create a `build` directory with the compiled executable. Run `./build/mdloader` to test.
6263

6364
## Usage
6465
```
@@ -82,20 +83,24 @@ Usage: mdloader [options] ...
8283

8384
To write firmware to the device and restart it:
8485

85-
`mdloader --first --download new_firmware.hex --restart`
86+
```
87+
mdloader --first --download new_firmware.hex --restart`
88+
```
8689

8790
The program will now be searching for your device. Press the reset switch found through the small hole on the back case or by appropriate key sequence to enter programming mode and allow programming to commence.
8891
Firmware may be provided as a binary ending in .bin or an Intel HEX format ending in .hex, but .hex is preferred for data integrity.
8992
Note that safeguards are in place to prevent overwriting the bootloader section of the device.
9093

9194
To read firmware from the device:
9295

93-
`mdloader --first --upload read_firmware.bin --addr 0x4000 --size 0x10000`
96+
```
97+
mdloader --first --upload read_firmware.bin --addr 0x4000 --size 0x10000
98+
```
9499

95-
Where --addr and --size are set as desired.
100+
Where `--addr` and `--size` are set as desired.
96101
Note the output of reading firmware will be in binary format.
97102

98-
Test mode may be invoked with the --test switch to test operations while preventing firmware modification.
103+
Test mode may be invoked with the `--test` switch to test operations while preventing firmware modification.
99104
Test mode also allows viewing of binary data from a read instead of writing to a file.
100105

101106
## Troubleshooting

0 commit comments

Comments
 (0)
Please sign in to comment.