Skip to content
Merged
Changes from 1 commit
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
dde6c9f
Start restructuring content and add preface
dleidert Jan 24, 2025
3f62bce
Update introduction
dleidert Jan 24, 2025
582afd9
Typo fix
dleidert Jan 24, 2025
e9ea4ca
Typo fix
dleidert Mar 19, 2025
a04a493
Rephrase the support status section
dleidert Mar 19, 2025
1ae4093
Move changelog and release model to appendix
dleidert Mar 19, 2025
e15a0c3
Rename section
dleidert Mar 19, 2025
ceb2e02
Rephrase the introduction to the getting started section
dleidert Mar 19, 2025
2bf78d1
Rewrite the image download section
dleidert Mar 19, 2025
7ff7c60
Change back to lowercase headings
dleidert Mar 19, 2025
5b59bdf
Rephrase the deploying image part
dleidert Mar 19, 2025
4ac5977
Minor updates to the first boot/login/installation
dleidert Mar 19, 2025
eb76eb0
Move installation and hardware tuning into a First steps section
dleidert Mar 19, 2025
f09abd6
Move firmware freeze and upgrade into Update section and create a Tro…
dleidert Mar 19, 2025
e81bfd2
Move the preface into the introduction
dleidert Mar 19, 2025
08d2f4d
Subtitle
dleidert Mar 19, 2025
d7ba7fe
Structuring
dleidert Mar 19, 2025
052dacc
Simple structure defition
dleidert Mar 19, 2025
280f9b8
Merge recovery into the troubleshooting section
dleidert Mar 19, 2025
2f1c531
Add a hint to armbian-config for first configuration
dleidert Mar 19, 2025
f8f0c59
Merge remote-tracking branch 'armbian/main'
dleidert Mar 21, 2025
4502239
Re-read the getting started section
dleidert Apr 7, 2025
2fee023
Move remaining pages into Advanced section
dleidert Apr 7, 2025
b8da932
Disable devicetree overlays
dleidert Apr 7, 2025
925a14d
Simple header rephrasing
dleidert Apr 7, 2025
7fb3955
Drop balenaetcher as discussed with @igorpecovnik
dleidert Apr 7, 2025
26deee3
Minor typo fixes
dleidert Apr 7, 2025
a6639fb
These sections are part of Getting started
dleidert Apr 7, 2025
d62fd6a
Add section for main project resources
dleidert Apr 7, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Rephrase the deploying image part
  • Loading branch information
dleidert committed Mar 19, 2025
commit 5b59bdff0563c1e7f60ca0c4fbdb2de0409b6820
11 changes: 7 additions & 4 deletions docs/User-Guide_Getting-Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,12 +151,13 @@ After you have downloaded these files, we recommend checking the integrity and t
```


## Deploy the Image
## Deploy the image

<!-- TODO: might be too much for novice users; needs to be shortened; maybe use admonitions -->

**Important note:** Make sure you use a **good, reliable and fast** SD card. If you encounter boot or stability troubles in over 95 percent of the time it is either insufficient power supply or related to SD card (bad card, bad card reader, something went wrong when burning the image, card too slow to boot -- 'Class 10' highly recommended!). Armbian can simply not run on unreliable hardware so checking your SD card with either [F3](https://fight-flash-fraud.readthedocs.io/en/stable/) or [H2testw](https://www.heise.de/download/product/h2testw-50539) is mandatory if you run in problems. Since [counterfeit SD cards](https://www.happybison.com/reviews/how-to-check-and-spot-fake-micro-sd-card-8/) are still an issue checking with F3/H2testw directly after purchase is **highly recommended**.
Before you start, there is an **important note:** Make sure you use a **good, reliable and fast** SD card. If you encounter boot or stability issues, in over 95 percent of the time it is either caused by an insufficient power supply or it is related to the SD card (due to a bad card, bad card reader, something went wrong when burning the image, card too slow to boot ... 'Class 10' is **highly** recommended!). Armbian can simply not run on unreliable hardware. So checking your SD card with either [F3](https://fight-flash-fraud.readthedocs.io/en/stable/) or [H2testw](https://www.heise.de/download/product/h2testw-50539) is mandatory if you run into problems. Since [counterfeit SD cards](https://www.happybison.com/reviews/how-to-check-and-spot-fake-micro-sd-card-8/) are still an issue, checking with F3/H2testw directly after purchase is also **highly recommended**.

Write the **.xz compressed image** with a tool [USBImager](https://gitlab.com/bztsrc/usbimager) or [balenaEtcher](https://www.balena.io/etcher/) on all platforms since, unlike other tools, either can validate written data **saving you from corrupted SD card contents**.
Write the **.xz compressed image** with a tool like [USBImager](https://gitlab.com/bztsrc/usbimager) or [balenaEtcher](https://www.balena.io/etcher/) on all platforms. Uunlike other tools, either of them can validate written data **saving you from corrupted SD card contents**.

!!! tip "Also important"

Expand All @@ -167,11 +168,13 @@ Write the **.xz compressed image** with a tool [USBImager](https://gitlab.com/bz
|Class 1 (A1)|![a1-logo](https://raw.githubusercontent.com/armbian/documentation/master/docs/images/a1-logo.png)|1500 4k IOPS|500 4k IOPS|10MBytes/sec|
|Class 2 (A2)|![a2-logo](https://raw.githubusercontent.com/armbian/documentation/master/docs/images/a2-logo.png)|4000 4k IOPS|2000 4k IOPS|10MBytes/sec|

<!-- TODO: Is that still correct?? -->

We recommend at least A1 rated SD-Cards ([A2 rated cards need yet lacking driver support and therefore show lower overall and especially random IO performance](https://github.com/ThomasKaiser/Knowledge/blob/master/articles/A1_and_A2_rated_SD_cards.md)). For example:

![a1-16gb-card](https://raw.githubusercontent.com/armbian/documentation/master/docs/images/sandisk-ultra-a1.png) ![a1-32gb-card](https://raw.githubusercontent.com/armbian/documentation/master/docs/images/sandisk-extremepro-a1.png) ![a2-64gb-card](https://raw.githubusercontent.com/armbian/documentation/master/docs/images/sandisk-extreme-a2.png)

In case you chose an SD card that was already in use before please consider resetting it back to 'factory default' performance with [SD Formatter](https://www.sdcard.org/downloads/formatter/) before burning Armbian to it ([explanation in the forum](https://forum.armbian.com/topic/3776-the-partition-is-not-resized-to-full-sd-card-size/&do=findComment&comment=27413)). Detailed information regarding ['factory default' SD card performance](https://forum.armbian.com/topic/954-sd-card-performance/page/3/&tab=comments#comment-49811).
In case you chose an SD card that was already in use before, please consider resetting it back to 'factory default' performance with [SD Formatter](https://www.sdcard.org/downloads/formatter/) before burning Armbian to it ([explanation in the forum](https://forum.armbian.com/topic/3776-the-partition-is-not-resized-to-full-sd-card-size/&do=findComment&comment=27413)). Detailed information regarding ['factory default' SD card performance](https://forum.armbian.com/topic/954-sd-card-performance/page/3/&tab=comments#comment-49811).

## How to boot

Expand Down