Skip to content

Commit 774977e

Browse files
committed
Make a separation on internal and external media, slightly reword
1 parent ce279ae commit 774977e

File tree

1 file changed

+58
-50
lines changed

1 file changed

+58
-50
lines changed

docs/User-Guide_Getting-Started.md

Lines changed: 58 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -175,78 +175,86 @@ After you have downloaded these files, we recommend checking the integrity and t
175175

176176
## Deploy the image
177177

178-
There are multiple ways to deploy the image to your board. The easiest and most common option is to write the Armbian Image to your SD-Card. Other options include using rkdeveloptool to flash the EMMC / UFS / SPI on Rockchip Boards directly over USB (via Maskrom Mode).
178+
There are multiple ways to deploy the image to your board. The easiest and most common option is to write the Armbian Image to your SD-Card.
179179

180-
=== "SD-Card"
180+
### SD Card
181181

182-
Write the **.xz compressed image** with a tool like [USBImager](https://gitlab.com/bztsrc/usbimager) onto your micro-SD card. Unlike other tools, it can validate written data **saving you from corrupted SD card contents**.
182+
Write the **.xz compressed image** with a tool like [USBImager](https://gitlab.com/bztsrc/usbimager) onto your **micro-SD card** or **USB drive** (if booting from it is supported). Unlike other tools, it can validate written data **saving you from corrupted SD card contents**.
183183

184-
!!! warning "Other tools"
184+
!!! warning "Other tools"
185185

186-
We are aware that there are many programs that can be used for this step. **But**, they usually cannot validate the written data to catch a bad card, a faulty card reader, problems writing the image. etc. Issues like these have caused too many error reports. Thus, please follow our advice and don't use other tools, especially if you are a novice user.
186+
We are aware that there are many programs that can be used for this step. **But**, they usually cannot validate the written data to catch a bad card, a faulty card reader, problems writing the image. etc. Issues like these have caused too many error reports. Thus, please follow our advice and don't use other tools, especially if you are a novice user.
187187

188-
Due to known issues, [balenaEtcher](https://www.balena.io/etcher/) can no longer be recommended as an alternative at this time.
188+
Due to known issues, [balenaEtcher](https://www.balena.io/etcher/) can no longer be recommended as an alternative at this time.
189189

190-
=== "RKdeveloptool"
191190

192-
=== "Debian"
191+
### Flash to Internal Memory
193192

194-
Install requirements
193+
Flash to Internal Memory allows you to write Armbian image directly to the device’s built‑in storage. This process completely replaces the existing system and erases all current data on the target drive. Use with caution, as once started, the operation cannot be undone.
195194

196-
``` bash
197-
sudo apt-get update
198-
sudo apt-get install -y libudev-dev libusb-1.0-0-dev dh-autoreconf pkg-config libusb-1.0 build-essential git wget
199-
```
195+
#### Rockchip
200196

201-
Download & Compile RKdeveloptool
197+
When a Rockchip device is placed into **Maskrom mode**, you can use `rkdeveloptool` to flash an image directly to its internal storage (**eMMC**, **UFS**, or **SPI**) over USB.
202198

203-
``` bash
204-
git clone https://github.com/rockchip-linux/rkdeveloptool
205-
cd rkdeveloptool
206-
autoreconf -i
207-
./configure
208-
make -j $(nproc)
209-
```
199+
=== "Debian"
210200

211-
Optionally install rkdeveloptool systemwide:
201+
Install requirements for `rkdeveloptool`
212202

213-
``` bash
214-
sudo cp rkdeveloptool /usr/local/sbin/
215-
```
203+
``` bash
204+
sudo apt-get update
205+
sudo apt-get install -y build-essential git wget
206+
sudo apt-get install -y libudev-dev libusb-1.0-0-dev dh-autoreconf pkg-config libusb-1.0
207+
```
208+
209+
Download & Compile `rkdeveloptool`
210+
211+
``` bash
212+
git clone https://github.com/rockchip-linux/rkdeveloptool
213+
cd rkdeveloptool
214+
autoreconf -i
215+
./configure
216+
make -j $(nproc)
217+
```
218+
219+
Optionally install `rkdeveloptool` systemwide:
216220

217-
=== "MacOS"
221+
``` bash
222+
sudo cp rkdeveloptool /usr/local/sbin/
223+
```
218224

219-
First make sure you have [brew](https://brew.sh) installed. Then you can run the following commands to install rkdeveloptool:
225+
=== "MacOS"
220226

221-
Install requirements
227+
First make sure you have [brew](https://brew.sh) installed. Then you can run the following commands to install rkdeveloptool:
222228

223-
``` bash
224-
brew install automake autoconf libusb pkg-config git wget
225-
```
229+
Install requirements
226230

227-
Download & Compile RKdeveloptool
231+
``` bash
232+
brew install automake autoconf libusb pkg-config git wget
233+
```
228234

229-
``` bash
230-
git clone https://github.com/rockchip-linux/rkdeveloptool
231-
cd rkdeveloptool
232-
autoreconf -i
233-
./configure
234-
make -j $(nproc)
235-
```
235+
Download & Compile `rkdeveloptool`
236236

237-
Optionally install rkdeveloptool systemwide:
237+
``` bash
238+
git clone https://github.com/rockchip-linux/rkdeveloptool
239+
cd rkdeveloptool
240+
autoreconf -i
241+
./configure
242+
make -j $(nproc)
243+
```
238244

239-
``` bash
240-
cp rkdeveloptool /opt/homebrew/bin/
241-
```
245+
Optionally install `rkdeveloptool` systemwide:
246+
247+
``` bash
248+
cp rkdeveloptool /opt/homebrew/bin/
249+
```
242250

243-
1. Connect & Boot your Board into Maskrom mode. Usually there is a button to hold for 5 seconds during boot else check your manufactures website.
244-
2. Run `rkdeveloptool ld` to list all connected devices
245-
3. Extract your image `unxz Armbian-YourBoard.img.xz`
246-
4. Flash the RK3XXX_loader.bin (check your SoC) via `rkdeveloptool db RK3XXX_loader.bin` which stands for download boot
247-
5. Erase the current storage medium (usually EMMC) via `rkdeveloptool ef` which stands for erase flash
248-
6. Now you can flash the extracted image with `rkdeveloptool wl 0 Armbian-YourBoard.img` (make sure the file ends with **.img**)
249-
7. Reboot your board with `rkdeveloptool rd` which stands for (power) reset device
251+
1. Connect & Boot your Board into Maskrom mode. Usually there is a button to hold for 5 seconds during boot else check your manufactures website.
252+
2. Run `rkdeveloptool ld` to list all connected devices
253+
3. Extract your image `unxz Armbian-YourBoard.img.xz`
254+
4. Flash the RK3XXX_loader.bin (check your SoC) via `rkdeveloptool db RK3XXX_loader.bin` which stands for download boot
255+
5. Erase the current storage medium (usually EMMC) via `rkdeveloptool ef` which stands for erase flash
256+
6. Now you can flash the extracted image with `rkdeveloptool wl 0 Armbian-YourBoard.img` (make sure the file ends with **.img**)
257+
7. Reboot your board with `rkdeveloptool rd` which stands for (power) reset device
250258

251259
## First boot
252260

0 commit comments

Comments
 (0)