funkey/FunKey-Project.github.io
1
0
Fork 0
mirror of https://github.com/FunKey-Project/FunKey-Project.github.io.git synced 2025-12-12 10:18:50 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Defined a naming convention for "FunKey S", "FunKey OS" and "FunKey SDK"

Browse Source
This commit is contained in:
DrUm78 2023-05-27 19:13:36 +02:00
parent 3f5d4d60a1
commit b2b7688992
11 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/developer_guide/software_reference/index.md
View File

@ -1,10 +1,10 @@
The **FunKey S** retro-gaming console software contains a set of
console emulators, standalone games, applications and utilities using
a custom Operating System (OS) that from now on will be referenced as
**_FunKey-OS_**.
**_FunKey OS_**.
The **FunKey-OS** is a Linux-based operating system, optimized for the
**FunKey-S** hardware, with a special focus on performance and fast
The **FunKey OS** is a Linux-based operating system, optimized for the
**FunKey S** hardware, with a special focus on performance and fast
boot time.
## Instant Action
@ -25,8 +25,8 @@ host computer when connected over USB.
## Video Processing
The **FunKey-S** CPU does not feature a GPU. For this reason, the
**FunKey-S** cannot use a hardware-accelerated OpenGL engine, and
The **FunKey S** CPU does not feature a GPU. For this reason, the
**FunKey S** cannot use a hardware-accelerated OpenGL engine, and
adding a software-emulated OpenGL-ES engine is not efficient, given
the limited CPU performance.

2
docs/developer_guide/software_reference/sd_card_layout/directory_structure.md
View File

@ -1,4 +1,4 @@
As the FunKey-OS is based on Linux, it conforms with a few exceptions
As the FunKey OS is based on Linux, it conforms with a few exceptions
to the [Filesystem Hierarchy Standard (FHS)][1].
## Hierarchies

6
docs/developer_guide/tutorials/build_system/build_program_using_sdk.md
View File

@ -2,13 +2,13 @@ This page will guide you through building a very simple application for FunKey u
FunKey is an embedded Linux device with an ARM processor at its core. Programs made for other computers will not work on FunKey, and developing programs on the FunKey itself is rather impractical. Instead, development for embedded devices like FunKey almost always uses a method known as cross compilation: building software on one platform (such as a desktop computer) to be used on another (like FunKey).
The FunKey-SDK contains a cross-compilation environment based on GCC, including the compiler toolchain and the libraries available on the FunKey.
The FunKey SDK contains a cross-compilation environment based on GCC, including the compiler toolchain and the libraries available on the FunKey.
Before we can begin, setup a Linux-based compilation environment as shown on [this page][1].
## Installing the FunKey-SDK
## Installing the FunKey SDK
The FunKey-SDK is included in releases of the FunKey-OS, starting from version 2.0.0, and can be found on [GitHub][2]. Alternatively, you can [compile the SDK yourself][3].
The FunKey-SDK is included in releases of the FunKey OS, starting from version 2.0.0, and can be found on [GitHub][2]. Alternatively, you can [compile the SDK yourself][3].
Unpack the SDK's .tar.gz file somewhere on your build system. Before you can use the SDK you must first run the **relocate-sdk.sh** script. This will update all references paths in the SDK to its current location. If you decide to move the SDK to another directory at a later point, don't forget to re-run the script.

6
docs/developer_guide/tutorials/build_system/compilation_environments.md
View File

@ -4,12 +4,12 @@ corresponding sources and the compilation by-products tend to be
rather large, such that an available disk space of at least 12GB is
required during the build.
And even if the resulting FunKey-OS boots in less than 5s, it still
And even if the resulting FunKey OS boots in less than 5s, it still
requires a fair amount of time to compile: please account for
1/2 hour on a modern multi-core CPU with SSD drives and a decent
Internet bandwidth.
The FunKey-OS is meant to be built on a native Ubuntu or Debian Linux
The FunKey OS is meant to be built on a native Ubuntu or Debian Linux
host machine (Ubuntu 20.04 LTS in our case, but this should also work
with other versions, too). And with only a few changes to the
prerequisites, it can certainly be adapted to build on other common
@ -138,7 +138,7 @@ With `<versionNumber>` set to `2` to use WSL2. You can use the same command with
Your Ubuntu installation is now ready to be used. Starting Ubuntu from the Start Menu will open a terminal with a Bash prompt. Everything you type here will be executed in Ubuntu. You can run and install applications within Ubuntu as you would on a complete installation or virtual machine.
Follow the instructions in the **Build on a Physical/Virtual Machine** section to install the requirements needed to build FunKey-OS.
Follow the instructions in the **Build on a Physical/Virtual Machine** section to install the requirements needed to build FunKey OS.
You can access the Windows filesystem via `/mnt`; the C: drive is mounted as `/mnt/c`. From Windows you can access the Linux filesystem via the special path `\\wsl$`. Note that you can only access the files there when Ubuntu is running on WSL2.

2
docs/developer_guide/tutorials/build_system/compile_sdk.md
View File

@ -1,6 +1,6 @@
Starting from version 2.0.0, the pre-compiled FunKey SDK is available
on [Github][1], and it is also compiled automatically as a first step
when building the [full FunKey-OS distribution][2].
when building the [full FunKey OS distribution][2].
However, if you want to compile the SDK only, here are the
instructions below:

2
docs/developer_guide/tutorials/build_system/get_sources.md
View File

@ -16,7 +16,7 @@ $ cd FunKey-OS
## In a Docker Container
When using a Docker container, you must first create a new directory
(here we create a `FunKey-OS` directory) and get the FunKey-OS
(here we create a `FunKey-OS` directory) and get the FunKey OS
[Dockerfile][1] in it:
```bash

8
docs/developer_guide/tutorials/build_system/index.md
View File

@ -1,4 +1,4 @@
The **FunKey-S** console is based on a sophisticated [Allwinner V3s
The **FunKey S** console is based on a sophisticated [Allwinner V3s
ARM Cortex-A7 1.2GHz CPU][2], an Operating System is mandatory in
order to access all the hardware resources without re-inventing the
wheel.
@ -12,7 +12,7 @@ method known as [cross compilation][2] for building software on a host
platform (such as a desktop computer) to be used on another target
platform (like the **FunKey S**).
The [FunKey-OS repository on Github][3] contains all the sources
The [FunKey OS repository on Github][3] contains all the sources
required to build the Open-Source firmware at the heart of the [FunKey
S retro-gaming console][4].
@ -22,11 +22,11 @@ binutils binary object tools, including the compiler toolchain and all
the required libraries available on the **FunKey S** in order to build
software for it.
FunKey-OS is based on Linux, and is built from scratch using the
FunKey OS is based on Linux, and is built from scratch using the
[buildroot][5] tool that simplifies and automates the process of
building a complete Linux system for an embedded system like this.
Technically speaking, Funkey-OS is a [buildroot (v2) based external
Technically speaking, FunKey OS is a [buildroot (v2) based external
tree][6] for building the bootloader, the Linux kernel and user
utilities, as well as the optimized retro-game launchers and console
emulators.

2
docs/developer_guide/tutorials/build_system/write_image.md
View File

@ -22,7 +22,7 @@ on the graphical screen.
## How to Update the FunKey S Firmware
It is possible to update the **FunKey-S** over USB, please follow the
It is possible to update the **FunKey S** over USB, please follow the
steps described in the [Firmware Upgrade][1] section.
[1]: /user_manual/tutorials/software/firmware_update/

6
docs/user_manual/tutorials/hardware/flash_change_sd_card.md
View File

@ -1,13 +1,13 @@
# Flashing a new micro-SD card
The following steps describe how to flash a micro-SD card with the
latest version of FunKey-OS. This must be done before switching
latest version of FunKey OS. This must be done before switching
micro-SD cards inside the console.
Note: Everything on the micro-SD card will be lost, be sure to save
your data.
## Download the latest FunKey-OS image file
## Download the latest FunKey OS image file
Get the latest "***FunKey-rootfs-x.y.z.img***" SD card image file
directly from [here][1] or from the bottom of the latest release page
@ -23,7 +23,7 @@ in the "assets" section:
[balena.io][3]{target=_blank}
- Run balenaEtcher and click on "Flash from file" to select the
FunKey-OS image file
FunKey OS image file
- Insert the micro-SD card in your computer and select the SD card
drive (balenaEtcher should automatically detect it for you)

2
docs/user_manual/tutorials/software/add_opk.md
View File

@ -5,7 +5,7 @@ does not require installation to be able to run them.
!!! Note
In the current release of the FunKey-OS (DrUm78's version), the **OPK** files
In the current release of the FunKey OS (DrUm78's version), the **OPK** files
are available both for the GMenu2X and RetroFE launchers. See documentation [here.][3]
[7-Zip][1] can be used to extract **OPK** files, and [Open Package

2
mkdocs.yml
View File

@ -14,7 +14,7 @@ site_description: >-
# Copyright
copyright: >
&copy; 2020-2023 FunKey Project<br/>
Last updated on 2023-05-26<br/>
Last updated on 2023-05-27<br/>
<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">
<img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/80x15.png" />
</a><br />This work is licensed under a