Skip to content

Commit 24c2bb5

Browse files
committed
Merge branch 'main' of github.com:PentHertz/rfswift-doc-v2
2 parents 224d1e4 + 0f34276 commit 24c2bb5

File tree

19 files changed

+265
-63
lines changed

19 files changed

+265
-63
lines changed

.github/workflows/hugobuild.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ on:
1010

1111
jobs:
1212
build_hugo:
13-
runs-on: ubuntu-22.04
13+
runs-on: ubuntu-latest
1414

1515
steps:
1616
- name: Checkout repository
@@ -19,7 +19,7 @@ jobs:
1919
- name: Set up Hugo
2020
uses: peaceiris/actions-hugo@v2
2121
with:
22-
hugo-version: 'latest'
22+
hugo-version: '0.139.4'
2323

2424
- name: Build Hugo site
2525
shell: bash

public/docs/development/building-images/index.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,13 @@
3939
<meta property="og:type" content="article" />
4040
<meta property="og:url" content="https://rfswift.io/docs/development/building-images/" /><meta property="article:section" content="docs" />
4141

42-
<meta property="article:modified_time" content="2024-12-11T00:40:51+01:00" />
42+
<meta property="article:modified_time" content="2024-12-17T18:38:18+01:00" />
4343

4444

4545
<meta itemprop="name" content="Building images">
4646
<meta itemprop="description" content="Available images are all present in the images submodule that can be checked with git as follows inside RF Swift root directory:
4747
git submodule update --init --recursive When entering the images directory, you can see different files and directory:">
48-
<meta itemprop="dateModified" content="2024-12-11T00:40:51+01:00">
48+
<meta itemprop="dateModified" content="2024-12-17T18:38:18+01:00">
4949
<meta itemprop="wordCount" content="535">
5050
<meta name="twitter:card" content="summary">
5151
<meta name="twitter:title" content="Building images">
@@ -715,7 +715,7 @@ <h2>List of harness functions<span class="hx-absolute -hx-mt-20" id="list-of-har
715715

716716
</div>
717717

718-
<div class="hx-mt-12 hx-mb-8 hx-block hx-text-xs hx-text-gray-500 ltr:hx-text-right rtl:hx-text-left dark:hx-text-gray-400">Last updated on <time datetime="2024-12-11T00:40:51.000Z">December 11, 2024</time></div>
718+
<div class="hx-mt-12 hx-mb-8 hx-block hx-text-xs hx-text-gray-500 ltr:hx-text-right rtl:hx-text-left dark:hx-text-gray-400">Last updated on <time datetime="2024-12-17T18:38:18.000Z">December 17, 2024</time></div>
719719
<div class="hx-mb-8 hx-flex hx-items-center hx-border-t hx-pt-8 dark:hx-border-neutral-800 contrast-more:hx-border-neutral-400 dark:contrast-more:hx-border-neutral-400 print:hx-hidden"><a
720720
href="/docs/development/compiling-rfswift/"
721721
title="Compiling RF Swift"

public/docs/development/compiling-rfswift/index.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,14 @@
4545
<meta property="og:type" content="article" />
4646
<meta property="og:url" content="https://rfswift.io/docs/development/compiling-rfswift/" /><meta property="article:section" content="docs" />
4747

48-
<meta property="article:modified_time" content="2024-12-11T00:40:51+01:00" />
48+
<meta property="article:modified_time" content="2024-12-17T18:38:18+01:00" />
4949

5050

5151
<meta itemprop="name" content="Compiling RF Swift">
5252
<meta itemprop="description" content="The project can install from source by following the simple steps:
5353
Installing RF Swift from source Get binary from GitHub Get the latest commit from the the official repository:
5454
git clone https://github.com/PentHertz/RF-Swift.git Use the installation script Two scripts are available to install all development tools if not installed and build the project:">
55-
<meta itemprop="dateModified" content="2024-12-11T00:40:51+01:00">
55+
<meta itemprop="dateModified" content="2024-12-17T18:38:18+01:00">
5656
<meta itemprop="wordCount" content="415">
5757
<meta name="twitter:card" content="summary">
5858
<meta name="twitter:title" content="Compiling RF Swift">
@@ -654,7 +654,7 @@ <h2>Next<span class="hx-absolute -hx-mt-20" id="next"></span>
654654

655655
</div>
656656

657-
<div class="hx-mt-12 hx-mb-8 hx-block hx-text-xs hx-text-gray-500 ltr:hx-text-right rtl:hx-text-left dark:hx-text-gray-400">Last updated on <time datetime="2024-12-11T00:40:51.000Z">December 11, 2024</time></div>
657+
<div class="hx-mt-12 hx-mb-8 hx-block hx-text-xs hx-text-gray-500 ltr:hx-text-right rtl:hx-text-left dark:hx-text-gray-400">Last updated on <time datetime="2024-12-17T18:38:18.000Z">December 17, 2024</time></div>
658658
<div class="hx-mb-8 hx-flex hx-items-center hx-border-t hx-pt-8 dark:hx-border-neutral-800 contrast-more:hx-border-neutral-400 dark:contrast-more:hx-border-neutral-400 print:hx-hidden"><a
659659
href="/docs/development/"
660660
title="🧑‍🍳 Development"

public/docs/development/index.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828

2929
<meta itemprop="name" content="🧑‍🍳 Developping around RF Swift">
3030
<meta itemprop="description" content="This section covers topics related to the development and contribution for RF Swift.">
31-
<meta itemprop="dateModified" content="2024-12-11T00:40:51+01:00">
31+
<meta itemprop="dateModified" content="2024-12-17T18:38:18+01:00">
3232
<meta itemprop="wordCount" content="41">
3333
<meta name="twitter:card" content="summary">
3434
<meta name="twitter:title" content="🧑‍🍳 Developping around RF Swift">
@@ -465,7 +465,7 @@ <h1>🧑‍🍳 Developping around RF Swift</h1>
465465
</div>
466466
</div>
467467

468-
<div class="hx-mt-12 hx-mb-8 hx-block hx-text-xs hx-text-gray-500 ltr:hx-text-right rtl:hx-text-left dark:hx-text-gray-400">Last updated on <time datetime="2024-12-11T00:40:51.000Z">December 11, 2024</time></div>
468+
<div class="hx-mt-12 hx-mb-8 hx-block hx-text-xs hx-text-gray-500 ltr:hx-text-right rtl:hx-text-left dark:hx-text-gray-400">Last updated on <time datetime="2024-12-17T18:38:18.000Z">December 17, 2024</time></div>
469469
<div class="hx-mb-8 hx-flex hx-items-center hx-border-t hx-pt-8 dark:hx-border-neutral-800 contrast-more:hx-border-neutral-400 dark:contrast-more:hx-border-neutral-400 print:hx-hidden"><a
470470
href="/docs/guide/"
471471
title="📖 Guide"

public/docs/getting-started/index.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -92,13 +92,13 @@
9292
<meta property="og:type" content="article" />
9393
<meta property="og:url" content="https://rfswift.io/docs/getting-started/" /><meta property="article:section" content="docs" />
9494

95-
<meta property="article:modified_time" content="2024-12-11T00:40:51+01:00" />
95+
<meta property="article:modified_time" content="2024-12-17T18:38:18+01:00" />
9696

9797

9898
<meta itemprop="name" content="Getting started">
9999
<meta itemprop="description" content="To get started using RF Swift, you first need to follow specific requirements.
100100
Supported on Platforms Plateform x86_64/amd64 arm64/v8 riscv64 Windows ✅ ❓ Linux ✅ ✅ ✅ macOS ❓ ✅ (better inside a VM for USB devices) Tested single-board computers SBC Status Comments Raspberry Pi 5 ✅ Works perfectly with most of the tools. Milk-V Jupiyter ✅ Works perfectly with most of the tools, but slower than Raspberry Pi 5. Milk-V Mars ❌ Software support is dead for the moment. Impossible to easily install Docker. UP Squared Series ✅ Works perfectly with most of the tools. Requirements The minimum requirements to run the project are the following:">
101-
<meta itemprop="dateModified" content="2024-12-11T00:40:51+01:00">
101+
<meta itemprop="dateModified" content="2024-12-17T18:38:18+01:00">
102102
<meta itemprop="wordCount" content="272">
103103
<meta name="twitter:card" content="summary">
104104
<meta name="twitter:title" content="Getting started">
@@ -741,7 +741,7 @@ <h2>Next<span class="hx-absolute -hx-mt-20" id="next"></span>
741741

742742
</div>
743743

744-
<div class="hx-mt-12 hx-mb-8 hx-block hx-text-xs hx-text-gray-500 ltr:hx-text-right rtl:hx-text-left dark:hx-text-gray-400">Last updated on <time datetime="2024-12-11T00:40:51.000Z">December 11, 2024</time></div>
744+
<div class="hx-mt-12 hx-mb-8 hx-block hx-text-xs hx-text-gray-500 ltr:hx-text-right rtl:hx-text-left dark:hx-text-gray-400">Last updated on <time datetime="2024-12-17T18:38:18.000Z">December 17, 2024</time></div>
745745
<div class="hx-mb-8 hx-flex hx-items-center hx-border-t hx-pt-8 dark:hx-border-neutral-800 contrast-more:hx-border-neutral-400 dark:contrast-more:hx-border-neutral-400 print:hx-hidden"><a
746746
href="/docs/"
747747
title="Documentation"

public/docs/guide/configurations/index.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -87,14 +87,14 @@
8787
<meta property="og:type" content="article" />
8888
<meta property="og:url" content="https://rfswift.io/docs/guide/configurations/" /><meta property="article:section" content="docs" />
8989

90-
<meta property="article:modified_time" content="2024-12-11T00:40:51+01:00" />
90+
<meta property="article:modified_time" content="2024-12-17T18:38:18+01:00" />
9191

9292

9393
<meta itemprop="name" content="Configurations">
9494
<meta itemprop="description" content="RF Swift can be configured on the fly, or using a profile configuration file for conveniency.
9595
Profil configuration Depending on your os, RF Swift will look for a profile configuration and ask you to create one if it is not found in the following path:
9696
LinuxWindowsmacOS X /home/username/.config/rfswift/config.ini C:\Users\username\AppData\Roaming\rfswift\config.ini /Users/username/.config/rfswift/config.ini This file contains different sections and lines parameters for RF Swift as follows:">
97-
<meta itemprop="dateModified" content="2024-12-11T00:40:51+01:00">
97+
<meta itemprop="dateModified" content="2024-12-17T18:38:18+01:00">
9898
<meta itemprop="wordCount" content="651">
9999
<meta name="twitter:card" content="summary">
100100
<meta name="twitter:title" content="Configurations">
@@ -835,7 +835,7 @@ <h3>API version mismatch<span class="hx-absolute -hx-mt-20" id="api-version-mism
835835

836836
</div>
837837

838-
<div class="hx-mt-12 hx-mb-8 hx-block hx-text-xs hx-text-gray-500 ltr:hx-text-right rtl:hx-text-left dark:hx-text-gray-400">Last updated on <time datetime="2024-12-11T00:40:51.000Z">December 11, 2024</time></div>
838+
<div class="hx-mt-12 hx-mb-8 hx-block hx-text-xs hx-text-gray-500 ltr:hx-text-right rtl:hx-text-left dark:hx-text-gray-400">Last updated on <time datetime="2024-12-17T18:38:18.000Z">December 17, 2024</time></div>
839839
<div class="hx-mb-8 hx-flex hx-items-center hx-border-t hx-pt-8 dark:hx-border-neutral-800 contrast-more:hx-border-neutral-400 dark:contrast-more:hx-border-neutral-400 print:hx-hidden"><a
840840
href="/docs/guide/list-of-tools/"
841841
title="Included tools"

public/docs/guide/host-actions/index.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -53,14 +53,14 @@
5353
<meta property="og:type" content="article" />
5454
<meta property="og:url" content="https://rfswift.io/docs/guide/host-actions/" /><meta property="article:section" content="docs" />
5555

56-
<meta property="article:modified_time" content="2024-12-11T00:40:51+01:00" />
56+
<meta property="article:modified_time" content="2024-12-17T18:38:18+01:00" />
5757

5858

5959
<meta itemprop="name" content="Host actions">
6060
<meta itemprop="description" content="Know we know how to run, configure, and manage images, let us see how we can also manage perform important host actions depending on the context.
6161
Enabling audio When running a container, you will probably encounter the following warning notification:
6262
┌──────────────────────────────────────────────────────────────────────────────────────────────────┐ │ ⚠️ Warning │ ├──────────────────────────────────────────────────────────────────────────────────────────────────┤ │ Warning: Unable to connect to Pulse server at 127.0.0.1:34567 │ │ To install Pulse server on Linux, follow these steps: │ │ 1. Update your package manager: sudo apt update (for Debian-based) or sudo yum update (for Red │ │ Hat-based). │ │ 2. Install Pulse server: sudo apt install pulse-server (for Debian-based) or sudo yum install │ │ pulse-server (for Red Hat-based). │ │ After installation, enable the module with the following command as unprivileged user: │ │ ./rfswift host audio enable │ └──────────────────────────────────────────────────────────────────────────────────────────────────┘ That means pulseaudio server is not found on the default IP and TCP port (127.0.0.1:34567)">
63-
<meta itemprop="dateModified" content="2024-12-11T00:40:51+01:00">
63+
<meta itemprop="dateModified" content="2024-12-17T18:38:18+01:00">
6464
<meta itemprop="wordCount" content="569">
6565
<meta name="twitter:card" content="summary">
6666
<meta name="twitter:title" content="Host actions">
@@ -727,7 +727,7 @@ <h2>Binding USB devices on a Windows host<span class="hx-absolute -hx-mt-20" id=
727727

728728
</div>
729729

730-
<div class="hx-mt-12 hx-mb-8 hx-block hx-text-xs hx-text-gray-500 ltr:hx-text-right rtl:hx-text-left dark:hx-text-gray-400">Last updated on <time datetime="2024-12-11T00:40:51.000Z">December 11, 2024</time></div>
730+
<div class="hx-mt-12 hx-mb-8 hx-block hx-text-xs hx-text-gray-500 ltr:hx-text-right rtl:hx-text-left dark:hx-text-gray-400">Last updated on <time datetime="2024-12-17T18:38:18.000Z">December 17, 2024</time></div>
731731
<div class="hx-mb-8 hx-flex hx-items-center hx-border-t hx-pt-8 dark:hx-border-neutral-800 contrast-more:hx-border-neutral-400 dark:contrast-more:hx-border-neutral-400 print:hx-hidden"><a
732732
href="/docs/guide/configurations/"
733733
title="Configurations"

public/docs/guide/index.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
<meta itemprop="name" content="Guide">
3131
<meta itemprop="description" content="This section covers topics related on how to run RF Swift and use the different softwares installed default images.
3232
Running RF Swift Configurations Container images Included tools Host actions Sharing files">
33-
<meta itemprop="dateModified" content="2024-12-11T00:40:51+01:00">
33+
<meta itemprop="dateModified" content="2024-12-17T18:38:18+01:00">
3434
<meta itemprop="wordCount" content="31">
3535
<meta name="twitter:card" content="summary">
3636
<meta name="twitter:title" content="Guide">
@@ -454,7 +454,7 @@ <h1>Guide</h1>
454454

455455
</div>
456456

457-
<div class="hx-mt-12 hx-mb-8 hx-block hx-text-xs hx-text-gray-500 ltr:hx-text-right rtl:hx-text-left dark:hx-text-gray-400">Last updated on <time datetime="2024-12-11T00:40:51.000Z">December 11, 2024</time></div>
457+
<div class="hx-mt-12 hx-mb-8 hx-block hx-text-xs hx-text-gray-500 ltr:hx-text-right rtl:hx-text-left dark:hx-text-gray-400">Last updated on <time datetime="2024-12-17T18:38:18.000Z">December 17, 2024</time></div>
458458
<div class="hx-mb-8 hx-flex hx-items-center hx-border-t hx-pt-8 dark:hx-border-neutral-800 contrast-more:hx-border-neutral-400 dark:contrast-more:hx-border-neutral-400 print:hx-hidden"><a
459459
href="/docs/quick-start/"
460460
title="🚀 Quick Start"

0 commit comments

Comments
 (0)