Skip to content

Commit f483a91

Browse files
author
github-actions
committed
Update docs preview for PR #792
1 parent d0ff0d6 commit f483a91

File tree

2 files changed

+57
-19
lines changed

2 files changed

+57
-19
lines changed

792/User-Guide_Getting-Started/index.html

Lines changed: 56 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -609,6 +609,45 @@
609609
</span>
610610
</a>
611611

612+
<nav class="md-nav" aria-label="Deploy the image">
613+
<ul class="md-nav__list">
614+
615+
<li class="md-nav__item">
616+
<a href="#sd-card" class="md-nav__link">
617+
<span class="md-ellipsis">
618+
SD Card
619+
</span>
620+
</a>
621+
622+
</li>
623+
624+
<li class="md-nav__item">
625+
<a href="#flash-to-internal-memory" class="md-nav__link">
626+
<span class="md-ellipsis">
627+
Flash to Internal Memory
628+
</span>
629+
</a>
630+
631+
<nav class="md-nav" aria-label="Flash to Internal Memory">
632+
<ul class="md-nav__list">
633+
634+
<li class="md-nav__item">
635+
<a href="#rockchip" class="md-nav__link">
636+
<span class="md-ellipsis">
637+
Rockchip
638+
</span>
639+
</a>
640+
641+
</li>
642+
643+
</ul>
644+
</nav>
645+
646+
</li>
647+
648+
</ul>
649+
</nav>
650+
612651
</li>
613652

614653
<li class="md-nav__item">
@@ -2393,27 +2432,29 @@ <h3 id="download-and-verification">Download and verification<a class="headerlink
23932432
</span></code></pre></div></td></tr></table></div>
23942433
</div>
23952434
<h2 id="deploy-the-image">Deploy the image<a class="headerlink" href="#deploy-the-image" title="Permanent link">&para;</a></h2>
2396-
<p>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).</p>
2397-
<div class="tabbed-set tabbed-alternate" data-tabs="1:2"><input checked="checked" id="deploy-the-image-sd-card" name="__tabbed_1" type="radio" /><input id="deploy-the-image-rkdeveloptool" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="deploy-the-image-sd-card">SD-Card</label><label for="deploy-the-image-rkdeveloptool">RKdeveloptool</label></div>
2398-
<div class="tabbed-content">
2399-
<div class="tabbed-block">
2400-
<p>Write the <strong>.xz compressed image</strong> with a tool like <a href="https://gitlab.com/bztsrc/usbimager">USBImager</a> onto your micro-SD card. Unlike other tools, it can validate written data <strong>saving you from corrupted SD card contents</strong>.</p>
2435+
<p>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. </p>
2436+
<h3 id="sd-card">SD Card<a class="headerlink" href="#sd-card" title="Permanent link">&para;</a></h3>
2437+
<p>Write the <strong>.xz compressed image</strong> with a tool like <a href="https://gitlab.com/bztsrc/usbimager">USBImager</a> onto your <strong>micro-SD card</strong> or <strong>USB drive</strong> (if booting from it is supported). Unlike other tools, it can validate written data <strong>saving you from corrupted SD card contents</strong>.</p>
24012438
<div class="admonition warning">
24022439
<p class="admonition-title">Other tools</p>
24032440
<p>We are aware that there are many programs that can be used for this step. <strong>But</strong>, 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&rsquo;t use other tools, especially if you are a novice user.</p>
24042441
<p>Due to known issues, <a href="https://www.balena.io/etcher/">balenaEtcher</a> can no longer be recommended as an alternative at this time.</p>
24052442
</div>
2406-
</div>
2407-
<div class="tabbed-block">
2408-
<div class="tabbed-set tabbed-alternate" data-tabs="2:2"><input checked="checked" id="deploy-the-image-debian" name="__tabbed_2" type="radio" /><input id="deploy-the-image-macos" name="__tabbed_2" type="radio" /><div class="tabbed-labels"><label for="deploy-the-image-debian">Debian</label><label for="deploy-the-image-macos">MacOS</label></div>
2443+
<h3 id="flash-to-internal-memory">Flash to Internal Memory<a class="headerlink" href="#flash-to-internal-memory" title="Permanent link">&para;</a></h3>
2444+
<p>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.</p>
2445+
<h4 id="rockchip">Rockchip<a class="headerlink" href="#rockchip" title="Permanent link">&para;</a></h4>
2446+
<p>When a Rockchip device is placed into <strong>Maskrom mode</strong>, you can use <code>rkdeveloptool</code> to flash an image directly to its internal storage (<strong>eMMC</strong>, <strong>UFS</strong>, or <strong>SPI</strong>) over USB.</p>
2447+
<div class="tabbed-set tabbed-alternate" data-tabs="1:2"><input checked="checked" id="rockchip-debian" name="__tabbed_1" type="radio" /><input id="rockchip-macos" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="rockchip-debian">Debian</label><label for="rockchip-macos">MacOS</label></div>
24092448
<div class="tabbed-content">
24102449
<div class="tabbed-block">
2411-
<p>Install requirements</p>
2450+
<p>Install requirements for <code>rkdeveloptool</code></p>
24122451
<div class="language-bash highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">Bash</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-6-1">1</a></span>
2413-
<span class="normal"><a href="#__codelineno-6-2">2</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1"></a>sudo<span class="w"> </span>apt-get<span class="w"> </span>update
2414-
</span><span id="__span-6-2"><a id="__codelineno-6-2" name="__codelineno-6-2"></a>sudo<span class="w"> </span>apt-get<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>libudev-dev<span class="w"> </span>libusb-1.0-0-dev<span class="w"> </span>dh-autoreconf<span class="w"> </span>pkg-config<span class="w"> </span>libusb-1.0<span class="w"> </span>build-essential<span class="w"> </span>git<span class="w"> </span>wget
2452+
<span class="normal"><a href="#__codelineno-6-2">2</a></span>
2453+
<span class="normal"><a href="#__codelineno-6-3">3</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1"></a>sudo<span class="w"> </span>apt-get<span class="w"> </span>update
2454+
</span><span id="__span-6-2"><a id="__codelineno-6-2" name="__codelineno-6-2"></a>sudo<span class="w"> </span>apt-get<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>build-essential<span class="w"> </span>git<span class="w"> </span>wget
2455+
</span><span id="__span-6-3"><a id="__codelineno-6-3" name="__codelineno-6-3"></a>sudo<span class="w"> </span>apt-get<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>libudev-dev<span class="w"> </span>libusb-1.0-0-dev<span class="w"> </span>dh-autoreconf<span class="w"> </span>pkg-config<span class="w"> </span>libusb-1.0
24152456
</span></code></pre></div></td></tr></table></div>
2416-
<p>Download &amp; Compile RKdeveloptool</p>
2457+
<p>Download &amp; Compile <code>rkdeveloptool</code></p>
24172458
<div class="language-bash highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">Bash</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-7-1">1</a></span>
24182459
<span class="normal"><a href="#__codelineno-7-2">2</a></span>
24192460
<span class="normal"><a href="#__codelineno-7-3">3</a></span>
@@ -2424,7 +2465,7 @@ <h2 id="deploy-the-image">Deploy the image<a class="headerlink" href="#deploy-th
24242465
</span><span id="__span-7-4"><a id="__codelineno-7-4" name="__codelineno-7-4"></a>./configure
24252466
</span><span id="__span-7-5"><a id="__codelineno-7-5" name="__codelineno-7-5"></a>make<span class="w"> </span>-j<span class="w"> </span><span class="k">$(</span>nproc<span class="k">)</span>
24262467
</span></code></pre></div></td></tr></table></div>
2427-
<p>Optionally install rkdeveloptool systemwide:</p>
2468+
<p>Optionally install <code>rkdeveloptool</code> systemwide:</p>
24282469
<div class="language-bash highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">Bash</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-8-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-8-1"><a id="__codelineno-8-1" name="__codelineno-8-1"></a>sudo<span class="w"> </span>cp<span class="w"> </span>rkdeveloptool<span class="w"> </span>/usr/local/sbin/
24292470
</span></code></pre></div></td></tr></table></div>
24302471
</div>
@@ -2433,7 +2474,7 @@ <h2 id="deploy-the-image">Deploy the image<a class="headerlink" href="#deploy-th
24332474
<p>Install requirements</p>
24342475
<div class="language-bash highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">Bash</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-9-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-9-1"><a id="__codelineno-9-1" name="__codelineno-9-1"></a>brew<span class="w"> </span>install<span class="w"> </span>automake<span class="w"> </span>autoconf<span class="w"> </span>libusb<span class="w"> </span>pkg-config<span class="w"> </span>git<span class="w"> </span>wget
24352476
</span></code></pre></div></td></tr></table></div>
2436-
<p>Download &amp; Compile RKdeveloptool</p>
2477+
<p>Download &amp; Compile <code>rkdeveloptool</code></p>
24372478
<div class="language-bash highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">Bash</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-10-1">1</a></span>
24382479
<span class="normal"><a href="#__codelineno-10-2">2</a></span>
24392480
<span class="normal"><a href="#__codelineno-10-3">3</a></span>
@@ -2444,7 +2485,7 @@ <h2 id="deploy-the-image">Deploy the image<a class="headerlink" href="#deploy-th
24442485
</span><span id="__span-10-4"><a id="__codelineno-10-4" name="__codelineno-10-4"></a>./configure
24452486
</span><span id="__span-10-5"><a id="__codelineno-10-5" name="__codelineno-10-5"></a>make<span class="w"> </span>-j<span class="w"> </span><span class="k">$(</span>nproc<span class="k">)</span>
24462487
</span></code></pre></div></td></tr></table></div>
2447-
<p>Optionally install rkdeveloptool systemwide:</p>
2488+
<p>Optionally install <code>rkdeveloptool</code> systemwide:</p>
24482489
<div class="language-bash highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">Bash</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-11-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-11-1"><a id="__codelineno-11-1" name="__codelineno-11-1"></a>cp<span class="w"> </span>rkdeveloptool<span class="w"> </span>/opt/homebrew/bin/
24492490
</span></code></pre></div></td></tr></table></div>
24502491
</div>
@@ -2459,9 +2500,6 @@ <h2 id="deploy-the-image">Deploy the image<a class="headerlink" href="#deploy-th
24592500
<li>Now you can flash the extracted image with <code>rkdeveloptool wl 0 Armbian-YourBoard.img</code> (make sure the file ends with <strong>.img</strong>)</li>
24602501
<li>Reboot your board with <code>rkdeveloptool rd</code> which stands for (power) reset device</li>
24612502
</ol>
2462-
</div>
2463-
</div>
2464-
</div>
24652503
<h2 id="first-boot">First boot<a class="headerlink" href="#first-boot" title="Permanent link">&para;</a></h2>
24662504
<p>If you used an SD card insert it into a slot and power on the board. With the cheapest board, the first boot (with DHCP) can take up to two minutes with a class 10 SD card.</p>
24672505
<h2 id="first-login">First login<a class="headerlink" href="#first-login" title="Permanent link">&para;</a></h2>

792/search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)