Skip to content

Commit

Permalink
Merge branch 'main' of github.com:PentHertz/rfswift-doc-v2
Browse files Browse the repository at this point in the history
  • Loading branch information
FlUxIuS committed Nov 10, 2024
2 parents c65e8a0 + 705c0b5 commit 911f041
Show file tree
Hide file tree
Showing 21 changed files with 344 additions and 164 deletions.
6 changes: 3 additions & 3 deletions public/docs/development/building-images/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,13 @@
<meta property="og:type" content="article" />
<meta property="og:url" content="https://rfswift.io/docs/development/building-images/" /><meta property="article:section" content="docs" />

<meta property="article:modified_time" content="2024-11-06T17:42:14+01:00" />
<meta property="article:modified_time" content="2024-11-08T16:08:55+01:00" />


<meta itemprop="name" content="Building images">
<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:
git submodule update --init --recursive When entering the images directory, you can see different files and directory:">
<meta itemprop="dateModified" content="2024-11-06T17:42:14+01:00">
<meta itemprop="dateModified" content="2024-11-08T16:08:55+01:00">
<meta itemprop="wordCount" content="535">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Building images">
Expand Down Expand Up @@ -715,7 +715,7 @@ <h2>List of harness functions<span class="hx-absolute -hx-mt-20" id="list-of-har

</div>

<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-11-06T17:42:14.000Z">November 6, 2024</time></div>
<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-11-08T16:08:55.000Z">November 8, 2024</time></div>
<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
href="/docs/development/compiling-rfswift/"
title="Compiling RF Swift"
Expand Down
6 changes: 3 additions & 3 deletions public/docs/development/compiling-rfswift/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,14 @@
<meta property="og:type" content="article" />
<meta property="og:url" content="https://rfswift.io/docs/development/compiling-rfswift/" /><meta property="article:section" content="docs" />

<meta property="article:modified_time" content="2024-11-06T17:42:14+01:00" />
<meta property="article:modified_time" content="2024-11-08T16:08:55+01:00" />


<meta itemprop="name" content="Compiling RF Swift">
<meta itemprop="description" content="The project can install from source by following the simple steps:
Installing RF Swift from source Get binary from GitHub Get the latest commit from the the official repository:
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:">
<meta itemprop="dateModified" content="2024-11-06T17:42:14+01:00">
<meta itemprop="dateModified" content="2024-11-08T16:08:55+01:00">
<meta itemprop="wordCount" content="415">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Compiling RF Swift">
Expand Down Expand Up @@ -654,7 +654,7 @@ <h2>Next<span class="hx-absolute -hx-mt-20" id="next"></span>

</div>

<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-11-06T17:42:14.000Z">November 6, 2024</time></div>
<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-11-08T16:08:55.000Z">November 8, 2024</time></div>
<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
href="/docs/development/"
title="🧑‍🍳 Development"
Expand Down
4 changes: 2 additions & 2 deletions public/docs/development/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@

<meta itemprop="name" content="🧑‍🍳 Developping around RF Swift">
<meta itemprop="description" content="This section covers topics related to the development and contribution for RF Swift.">
<meta itemprop="dateModified" content="2024-11-06T17:42:14+01:00">
<meta itemprop="dateModified" content="2024-11-08T16:08:55+01:00">
<meta itemprop="wordCount" content="41">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="🧑‍🍳 Developping around RF Swift">
Expand Down Expand Up @@ -465,7 +465,7 @@ <h1>🧑‍🍳 Developping around RF Swift</h1>
</div>
</div>

<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-11-06T17:42:14.000Z">November 6, 2024</time></div>
<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-11-08T16:08:55.000Z">November 8, 2024</time></div>
<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
href="/docs/guide/"
title="📖 Guide"
Expand Down
6 changes: 3 additions & 3 deletions public/docs/getting-started/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,13 +92,13 @@
<meta property="og:type" content="article" />
<meta property="og:url" content="https://rfswift.io/docs/getting-started/" /><meta property="article:section" content="docs" />

<meta property="article:modified_time" content="2024-11-06T17:42:14+01:00" />
<meta property="article:modified_time" content="2024-11-08T16:08:55+01:00" />


<meta itemprop="name" content="Getting started">
<meta itemprop="description" content="To get started using RF Swift, you first need to follow specific requirements.
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:">
<meta itemprop="dateModified" content="2024-11-06T17:42:14+01:00">
<meta itemprop="dateModified" content="2024-11-08T16:08:55+01:00">
<meta itemprop="wordCount" content="272">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Getting started">
Expand Down Expand Up @@ -741,7 +741,7 @@ <h2>Next<span class="hx-absolute -hx-mt-20" id="next"></span>

</div>

<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-11-06T17:42:14.000Z">November 6, 2024</time></div>
<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-11-08T16:08:55.000Z">November 8, 2024</time></div>
<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
href="/docs/"
title="Documentation"
Expand Down
6 changes: 3 additions & 3 deletions public/docs/guide/configurations/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -87,14 +87,14 @@
<meta property="og:type" content="article" />
<meta property="og:url" content="https://rfswift.io/docs/guide/configurations/" /><meta property="article:section" content="docs" />

<meta property="article:modified_time" content="2024-11-06T17:42:14+01:00" />
<meta property="article:modified_time" content="2024-11-08T16:08:55+01:00" />


<meta itemprop="name" content="Configurations">
<meta itemprop="description" content="RF Swift can be configured on the fly, or using a profile configuration file for conveniency.
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:
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:">
<meta itemprop="dateModified" content="2024-11-06T17:42:14+01:00">
<meta itemprop="dateModified" content="2024-11-08T16:08:55+01:00">
<meta itemprop="wordCount" content="312">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Configurations">
Expand Down Expand Up @@ -703,7 +703,7 @@ <h2>Parameters from CLI<span class="hx-absolute -hx-mt-20" id="parameters-from-c

</div>

<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-11-06T17:42:14.000Z">November 6, 2024</time></div>
<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-11-08T16:08:55.000Z">November 8, 2024</time></div>
<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
href="/docs/guide/list-of-tools/"
title="Included tools"
Expand Down
6 changes: 3 additions & 3 deletions public/docs/guide/host-actions/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,14 +53,14 @@
<meta property="og:type" content="article" />
<meta property="og:url" content="https://rfswift.io/docs/guide/host-actions/" /><meta property="article:section" content="docs" />

<meta property="article:modified_time" content="2024-11-06T17:42:14+01:00" />
<meta property="article:modified_time" content="2024-11-08T16:08:55+01:00" />


<meta itemprop="name" content="Host actions">
<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.
Enabling audio When running a container, you will probably encounter the following warning notification:
┌──────────────────────────────────────────────────────────────────────────────────────────────────┐ │ ⚠️ 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)">
<meta itemprop="dateModified" content="2024-11-06T17:42:14+01:00">
<meta itemprop="dateModified" content="2024-11-08T16:08:55+01:00">
<meta itemprop="wordCount" content="569">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Host actions">
Expand Down Expand Up @@ -727,7 +727,7 @@ <h2>Binding USB devices on a Windows host<span class="hx-absolute -hx-mt-20" id=

</div>

<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-11-06T17:42:14.000Z">November 6, 2024</time></div>
<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-11-08T16:08:55.000Z">November 8, 2024</time></div>
<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
href="/docs/guide/configurations/"
title="Configurations"
Expand Down
4 changes: 2 additions & 2 deletions public/docs/guide/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
<meta itemprop="name" content="Guide">
<meta itemprop="description" content="This section covers topics related on how to run RF Swift and use the different softwares installed default images.
Running RF Swift Configurations Container images Included tools Host actions Sharing files">
<meta itemprop="dateModified" content="2024-11-06T17:42:14+01:00">
<meta itemprop="dateModified" content="2024-11-08T16:08:55+01:00">
<meta itemprop="wordCount" content="31">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Guide">
Expand Down Expand Up @@ -454,7 +454,7 @@ <h1>Guide</h1>

</div>

<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-11-06T17:42:14.000Z">November 6, 2024</time></div>
<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-11-08T16:08:55.000Z">November 8, 2024</time></div>
<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
href="/docs/quick-start/"
title="🚀 Quick Start"
Expand Down
Loading

0 comments on commit 911f041

Please sign in to comment.