Skip to content

Commit b2b7688

Browse files
committed
Defined a naming convention for "FunKey S", "FunKey OS" and "FunKey SDK"
1 parent 3f5d4d6 commit b2b7688

File tree

11 files changed

+24
-24
lines changed

11 files changed

+24
-24
lines changed

docs/developer_guide/software_reference/index.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
The **FunKey S** retro-gaming console software contains a set of
22
console emulators, standalone games, applications and utilities using
33
a custom Operating System (OS) that from now on will be referenced as
4-
**_FunKey-OS_**.
4+
**_FunKey OS_**.
55

6-
The **FunKey-OS** is a Linux-based operating system, optimized for the
7-
**FunKey-S** hardware, with a special focus on performance and fast
6+
The **FunKey OS** is a Linux-based operating system, optimized for the
7+
**FunKey S** hardware, with a special focus on performance and fast
88
boot time.
99

1010
## Instant Action
@@ -25,8 +25,8 @@ host computer when connected over USB.
2525

2626
## Video Processing
2727

28-
The **FunKey-S** CPU does not feature a GPU. For this reason, the
29-
**FunKey-S** cannot use a hardware-accelerated OpenGL engine, and
28+
The **FunKey S** CPU does not feature a GPU. For this reason, the
29+
**FunKey S** cannot use a hardware-accelerated OpenGL engine, and
3030
adding a software-emulated OpenGL-ES engine is not efficient, given
3131
the limited CPU performance.
3232

docs/developer_guide/software_reference/sd_card_layout/directory_structure.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
As the FunKey-OS is based on Linux, it conforms with a few exceptions
1+
As the FunKey OS is based on Linux, it conforms with a few exceptions
22
to the [Filesystem Hierarchy Standard (FHS)][1].
33

44
## Hierarchies

docs/developer_guide/tutorials/build_system/build_program_using_sdk.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@ This page will guide you through building a very simple application for FunKey u
22

33
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).
44

5-
The FunKey-SDK contains a cross-compilation environment based on GCC, including the compiler toolchain and the libraries available on the FunKey.
5+
The FunKey SDK contains a cross-compilation environment based on GCC, including the compiler toolchain and the libraries available on the FunKey.
66

77
Before we can begin, setup a Linux-based compilation environment as shown on [this page][1].
88

9-
## Installing the FunKey-SDK
9+
## Installing the FunKey SDK
1010

11-
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].
11+
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].
1212

1313
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.
1414

docs/developer_guide/tutorials/build_system/compilation_environments.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ corresponding sources and the compilation by-products tend to be
44
rather large, such that an available disk space of at least 12GB is
55
required during the build.
66

7-
And even if the resulting FunKey-OS boots in less than 5s, it still
7+
And even if the resulting FunKey OS boots in less than 5s, it still
88
requires a fair amount of time to compile: please account for
99
1/2 hour on a modern multi-core CPU with SSD drives and a decent
1010
Internet bandwidth.
1111

12-
The FunKey-OS is meant to be built on a native Ubuntu or Debian Linux
12+
The FunKey OS is meant to be built on a native Ubuntu or Debian Linux
1313
host machine (Ubuntu 20.04 LTS in our case, but this should also work
1414
with other versions, too). And with only a few changes to the
1515
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
138138

139139
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.
140140

141-
Follow the instructions in the **Build on a Physical/Virtual Machine** section to install the requirements needed to build FunKey-OS.
141+
Follow the instructions in the **Build on a Physical/Virtual Machine** section to install the requirements needed to build FunKey OS.
142142

143143
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.
144144

docs/developer_guide/tutorials/build_system/compile_sdk.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Starting from version 2.0.0, the pre-compiled FunKey SDK is available
22
on [Github][1], and it is also compiled automatically as a first step
3-
when building the [full FunKey-OS distribution][2].
3+
when building the [full FunKey OS distribution][2].
44

55
However, if you want to compile the SDK only, here are the
66
instructions below:

docs/developer_guide/tutorials/build_system/get_sources.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ $ cd FunKey-OS
1616
## In a Docker Container
1717

1818
When using a Docker container, you must first create a new directory
19-
(here we create a `FunKey-OS` directory) and get the FunKey-OS
19+
(here we create a `FunKey-OS` directory) and get the FunKey OS
2020
[Dockerfile][1] in it:
2121

2222
```bash

docs/developer_guide/tutorials/build_system/index.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
The **FunKey-S** console is based on a sophisticated [Allwinner V3s
1+
The **FunKey S** console is based on a sophisticated [Allwinner V3s
22
ARM Cortex-A7 1.2GHz CPU][2], an Operating System is mandatory in
33
order to access all the hardware resources without re-inventing the
44
wheel.
@@ -12,7 +12,7 @@ method known as [cross compilation][2] for building software on a host
1212
platform (such as a desktop computer) to be used on another target
1313
platform (like the **FunKey S**).
1414

15-
The [FunKey-OS repository on Github][3] contains all the sources
15+
The [FunKey OS repository on Github][3] contains all the sources
1616
required to build the Open-Source firmware at the heart of the [FunKey
1717
S retro-gaming console][4].
1818

@@ -22,11 +22,11 @@ binutils binary object tools, including the compiler toolchain and all
2222
the required libraries available on the **FunKey S** in order to build
2323
software for it.
2424

25-
FunKey-OS is based on Linux, and is built from scratch using the
25+
FunKey OS is based on Linux, and is built from scratch using the
2626
[buildroot][5] tool that simplifies and automates the process of
2727
building a complete Linux system for an embedded system like this.
2828

29-
Technically speaking, Funkey-OS is a [buildroot (v2) based external
29+
Technically speaking, FunKey OS is a [buildroot (v2) based external
3030
tree][6] for building the bootloader, the Linux kernel and user
3131
utilities, as well as the optimized retro-game launchers and console
3232
emulators.

docs/developer_guide/tutorials/build_system/write_image.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ on the graphical screen.
2222

2323
## How to Update the FunKey S Firmware
2424

25-
It is possible to update the **FunKey-S** over USB, please follow the
25+
It is possible to update the **FunKey S** over USB, please follow the
2626
steps described in the [Firmware Upgrade][1] section.
2727

2828
[1]: /user_manual/tutorials/software/firmware_update/

docs/user_manual/tutorials/hardware/flash_change_sd_card.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Flashing a new micro-SD card
22

33
The following steps describe how to flash a micro-SD card with the
4-
latest version of FunKey-OS. This must be done before switching
4+
latest version of FunKey OS. This must be done before switching
55
micro-SD cards inside the console.
66

77
Note: Everything on the micro-SD card will be lost, be sure to save
88
your data.
99

10-
## Download the latest FunKey-OS image file
10+
## Download the latest FunKey OS image file
1111

1212
Get the latest "***FunKey-rootfs-x.y.z.img***" SD card image file
1313
directly from [here][1] or from the bottom of the latest release page
@@ -23,7 +23,7 @@ in the "assets" section:
2323
[balena.io][3]{target=_blank}
2424

2525
- Run balenaEtcher and click on "Flash from file" to select the
26-
FunKey-OS image file
26+
FunKey OS image file
2727

2828
- Insert the micro-SD card in your computer and select the SD card
2929
drive (balenaEtcher should automatically detect it for you)

docs/user_manual/tutorials/software/add_opk.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ does not require installation to be able to run them.
55

66
!!! Note
77

8-
In the current release of the FunKey-OS (DrUm78's version), the **OPK** files
8+
In the current release of the FunKey OS (DrUm78's version), the **OPK** files
99
are available both for the GMenu2X and RetroFE launchers. See documentation [here.][3]
1010

1111
[7-Zip][1] can be used to extract **OPK** files, and [Open Package

mkdocs.yml

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

0 commit comments

Comments
 (0)