Update README.md, inform about battery

This commit is contained in:
Konrad Beckmann 2020-12-10 20:55:29 +01:00
parent 9faf5f3bb6
commit 85a118119a
1 changed files with 3 additions and 1 deletions

View File

@ -20,7 +20,7 @@ Feel free to join our [discord channel](https://discord.gg/rE2nHVAKvn) and ask a
This manual is for developers, and not yet suitable for end-users. The goal is to enable other developers to be able to contribute to Game & Watch development, and hopefully eventually get to a point where we can release end-user instructions :) This manual is for developers, and not yet suitable for end-users. The goal is to enable other developers to be able to contribute to Game & Watch development, and hopefully eventually get to a point where we can release end-user instructions :)
Please note that we recommend either a (full-size, not mini) J-Link/J-Link Edu, or an offical ST-Link. ST-Link clones have caused a lot of issues, please avoid them. Also please remove the battery before you continue. Please note that we recommend either a (full-size, not mini) J-Link/J-Link Edu, or an offical ST-Link. ST-Link clones have caused a lot of issues, please avoid them. Also please disconnect the battery before you continue.
## Connecting the debugger ## Connecting the debugger
@ -72,6 +72,8 @@ brew install arm-none-eabi-gcc
## Usage ## Usage
Before starting, make sure to unplug the battery as it can interfere with the process. Power the device using the USB-C connector.
The scripts are split into 5 parts: The scripts are split into 5 parts:
- 1_sanity_check.sh - Performs sanity check and makes sure all required tools are available - 1_sanity_check.sh - Performs sanity check and makes sure all required tools are available