mirror of
https://github.com/FunKey-Project/FunKey-Project.github.io.git
synced 2026-03-19 18:32:51 +01:00
- Commented several empty sections in mkdocs.yml (will reactivate them later if someone fills them)
- Enabled 'Directory Structure' section that was not present in mkdocs.yml - Removed all links to empty sections - Fixed incorrect links that led to a 404 error - Updated art covers url - Redirected former FunKey OS links to my release page - Updated a few things in some sections - Fixed a few typos
This commit is contained in:
@@ -126,7 +126,7 @@ are shared with the other I2C peripherals (the PMIC) on the bus.
|
||||
It is then much easier to route this dense PCB by delegating the
|
||||
button GPIO handling to a satellite chip.
|
||||
|
||||
[1]: /developers/hardware/power/pmic
|
||||
[1]: /developer_guide/hardware_reference/power/pmic
|
||||
[2]: https://hackaday.io/project/134065
|
||||
[3]: https://github.com/FunKey-Project/FunKey-S-Hardware/blob/master/Datasheets/Replacement%20EVP-BB1AAB000-(Operating%20force%20120GF%EF%BC%89.pdf
|
||||
[4]: https://github.com/FunKey-Project/FunKey-S-Hardware/blob/master/Datasheets/replacement%20EVP-AEBB2A-1.pdf
|
||||
|
||||
@@ -203,7 +203,7 @@ resistor **R11** connected internally like this:
|
||||
More information on the DDR2 DRAM ZQ Calibration subject can be found
|
||||
in this [Micron Application Note][14].
|
||||
|
||||
[1]: /developers/hardware/design/#design-constraints
|
||||
[1]: /developer_guide/hardware_reference/#design-constraints
|
||||
[2]: https://www.electronicsweekly.com/news/products/memory/how-to-guide-for-on-chip-memory-2012-06/
|
||||
[3]: https://www.apple.com/mac/m1/
|
||||
[4]: https://www.microchip.com/design-centers/32-bit-mpus/sip-som/system-in-package
|
||||
|
||||
@@ -110,12 +110,12 @@ DRAM power supply voltage level, which is used for the integrated DDR2
|
||||
DRAM merged drivers and dynamic on-chip termination already discussed
|
||||
at the end of the previous [CPU schematic description][6].
|
||||
|
||||
[1]: /developers/hardware/cpu
|
||||
[2]: /developers/hardware/power/pmic
|
||||
[3]: /developers/hardware/audio
|
||||
[4]: /developers/hardware/buttons
|
||||
[1]: /developer_guide/hardware_reference/cpu/#crystals
|
||||
[2]: /developer_guide/hardware_reference/power/pmic
|
||||
[3]: /developer_guide/hardware_reference/audio/#schematic
|
||||
[4]: /developer_guide/hardware_reference/buttons/#schematics
|
||||
[5]: https://github.com/Squonk42/V3s_Documentation/blob/master/V3s%20hardware%20design%20guide%20V1.0_20150519%20EN%20Non%20Official.pdf
|
||||
[6]: /developers/hardware/cpu
|
||||
[6]: /developer_guide/hardware_reference/cpu/#dram
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
|
||||
@@ -105,7 +105,7 @@ supply voltage has a good reason to exist:
|
||||
swing and increase the possible CPU frequency. Given the required
|
||||
current, a SMPS is required for reaching a good efficiency, too
|
||||
|
||||
[1]: /developers/hardware/cpu#cpu-schematics
|
||||
[1]: /developer_guide/hardware_reference/cpu/#cpu-schematics
|
||||
[2]: https://github.com/Squonk42/V3s_Documentation/blob/master/V3S_CDR_STD_V1_0_20150514.pdf
|
||||
|
||||
--8<--
|
||||
|
||||
@@ -292,7 +292,7 @@ phones.
|
||||
[10]: https://github.com/Squonk42/V3s_Documentation/raw/master/V3s%20hardware%20design%20guide%20V1.0_20150519%20EN%20Non%20Official.pdf
|
||||
[11]: https://github.com/FunKey-Project/FunKey-S-Hardware/blob/master/Datasheets/1811151533_JST-Sales-America-SM02B-SRSS-TB-LF-SN_C160402.pdf
|
||||
[12]: https://github.com/FunKey-Project/FunKey-S-Hardware/blob/master/Datasheets/C165977_%E8%B4%B4%E7%89%87LED%E8%93%9D%E8%89%B2_2018-01-26.PDF
|
||||
[13]: /developers/hardware/magnetic_switch
|
||||
[13]: /developer_guide/hardware_reference/magnetic_switch/
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
|
||||
@@ -117,7 +117,7 @@ supply voltage when initially powered up.
|
||||
[1]: https://www.sdcard.org/downloads/pls/click.php?p=Part1_Physical_Layer_Simplified_Specification_Ver6.00.jpg&f=Part1_Physical_Layer_Simplified_Specification_Ver6.00.pdf&e=EN_SS1
|
||||
[2]: https://www.jedec.org/document_search/field_keywords/emmc-3147
|
||||
[3]: https://www.mouser.com/catalog/specsheets/an10911.pdf
|
||||
[4]: /developers/hardware/cpu
|
||||
[4]: /developer_guide/hardware_reference/cpu/#sd-card
|
||||
[5]: https://github.com/FunKey-Project/FunKey-S-Hardware/blob/master/Datasheets/C266613_%E6%8A%BD%E6%8B%89%E5%BC%8FTF%E5%8D%A1%E5%BA%A7_2018-08-20.PDF
|
||||
|
||||
--8<--
|
||||
|
||||
@@ -39,15 +39,15 @@ order:
|
||||
|
||||
- The [SPL][3] (Secondary Program Loader)
|
||||
|
||||
- The [U-Boot bootloader][4]
|
||||
- The U-Boot bootloader
|
||||
|
||||
- The [Linux kernel][5]
|
||||
- The Linux kernel
|
||||
|
||||
- The userland [System V init scripts][6]
|
||||
- The userland System V init scripts
|
||||
|
||||
## Shutdown Process
|
||||
|
||||
Unlike the startup process, the [shutdown process][7] is much more
|
||||
Unlike the startup process, the shutdown process is much more
|
||||
straightforward, but it must be optimized to run as quiclky as
|
||||
possible, as the time from when the shutdown is initiated when the
|
||||
user press the <i class="funkey-menu"></i> key or close the **FunKey
|
||||
|
||||
@@ -23,9 +23,6 @@ The only storage system available in the **FunKey S** is its
|
||||
integrated MicroSD card. Most of its contents is made available to a
|
||||
host computer when connected over USB.
|
||||
|
||||
The MicroSD card format is detailed in the [Disk Partition][2]
|
||||
section.
|
||||
|
||||
## Video Processing
|
||||
|
||||
The **FunKey-S** CPU does not feature a GPU. For this reason, the
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
As the FunKey-OS is based on Linux, it conforms with a few exceptions
|
||||
to the [Filesystem Hierarchy Standard (FHS)][1].
|
||||
|
||||
## Hierearchies
|
||||
## Hierarchies
|
||||
|
||||
The FHS defines 3 hierarchies of directories:
|
||||
|
||||
|
||||
@@ -29,8 +29,7 @@ the familiar **FunKey S** logo:
|
||||
|
||||
The Recovery Mode automatically enables the USB network client upon
|
||||
startup, allowing ssh connection over the USB cable for debug
|
||||
purposes. For more information, please check the [SSH Connection over
|
||||
USB section][1].
|
||||
purposes.
|
||||
|
||||
At the same time, the Recovery mode provides a simple text menu, with
|
||||
the current menu item displayed at the top of the screen.
|
||||
@@ -50,8 +49,8 @@ This command displays useful information regarding the **FunKey S**:
|
||||
- if connected to a host through USB network, the device IP address
|
||||
|
||||
```
|
||||
Recovery: 2.0.0
|
||||
rootfs : 2.0.0
|
||||
Recovery: 2.3.0
|
||||
rootfs : 2.3.0
|
||||
IP addr : 192.168.137.20
|
||||
```
|
||||
|
||||
|
||||
@@ -66,27 +66,25 @@ The **hello** program you've just created is a valid executable for FunKey, but
|
||||
|
||||
- The **hello** program.
|
||||
- An icon for your program in PNG format, 32 x 32 pixels in size, called **hello.png**.
|
||||
- A *desktop* file called **hello.funkey-s.desktop**, containing the following text:
|
||||
- A *desktop* file called **hello.funkey-s.desktop** ("funkey-s" is mandatory here), containing the following text:
|
||||
|
||||
```ini
|
||||
[Desktop Entry]
|
||||
Type=Application
|
||||
Name=Hello
|
||||
Comment=A simple test app
|
||||
Exec=hello
|
||||
Icon=hello
|
||||
Terminal=false
|
||||
Categories=applications;
|
||||
Categories=applications
|
||||
```
|
||||
|
||||
**Note: You need to add an extra empty line at the end of the .desktop file or it won't work!**
|
||||
|
||||
[This file describes your program to the launcher][4]:
|
||||
|
||||
- **Type**: Always set to "Application"
|
||||
- **Name**: This is the name of the application shown in the launcher
|
||||
- **Comment**: A description of the application
|
||||
- **Exec**: This the command to execute your program
|
||||
- **Icon**: The name of the icon file, without the .png extension
|
||||
- **Terminal**: Always set to false, FunKey doesn't support terminal applications
|
||||
- **Categories**: The categories under which the launcher will show the application, in a semicolon-separated list
|
||||
|
||||
Once you've got everything ready you can turn the folder into a package using the [OpenPackage Creator][5]. Select your folder with the **Open** button, or drag it over the window. The OpenPackage Creator will note that you've already created *.desktop* file. Choose the "Use existing as is" option. Finally, click the **Pack** button to create **hello.opk**, ready to be transferred to the FunKey.
|
||||
@@ -102,7 +100,7 @@ Your application is now installed on FunKey. Note that **only the GMENU2X launch
|
||||

|
||||
|
||||
[1]: ../compilation_environments
|
||||
[2]: https://github.com/FunKey-Project/FunKey-OS/releases/
|
||||
[2]: https://github.com/DrUm78/FunKey-OS/releases/
|
||||
[3]: ../compile_sdk
|
||||
[4]: https://github.com/gcwnow/buildroot/wiki/Package-file-format
|
||||
[5]: https://github.com/Harteex/OpenPackageCreator/releases
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
Even if the resulting disk image and firmware update files are
|
||||
relatively small (202 MB and 55MB, respectively), the size of the
|
||||
relatively small (350MB and 110MB, respectively), the size of the
|
||||
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
|
||||
requires a considerable amount of time to compile: please account for
|
||||
1 1/2 hour on a modern multi-core CPU with SSD drives and a decent
|
||||
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
|
||||
@@ -76,14 +76,13 @@ install the following packages beforehand:
|
||||
- tar
|
||||
- unzip
|
||||
- wget
|
||||
- which
|
||||
- xxd
|
||||
|
||||
On Ubuntu/Debian Linux, this is achieved by running the following
|
||||
command:
|
||||
|
||||
```bash
|
||||
$ sudo apt install bash bc binutils build-essential bzip2 ca-certificates cpio cvs expect file g++ gcc git gzip liblscp-dev libncurses5-dev locales make mercurial openssh-client patch perl procps python python-dev python3 python3-dev python3-distutils python3-setuptools rsync rsync sed subversion sudo tar unzip wget which xxd
|
||||
$ sudo apt install bash bc binutils build-essential bzip2 ca-certificates cpio cvs expect file g++ gcc git gzip liblscp-dev libncurses5-dev locales make mercurial openssh-client patch perl procps python python-dev python3 python3-dev python3-distutils python3-setuptools rsync rsync sed subversion sudo tar unzip wget xxd
|
||||
```
|
||||
|
||||
## Build in a Docker Container
|
||||
@@ -93,11 +92,11 @@ $ sudo apt install bash bc binutils build-essential bzip2 ca-certificates cpio c
|
||||
When using a Docker container, all the prerequisites are automatically
|
||||
installed.
|
||||
|
||||
## Build on Windows 10 with WSL2
|
||||
## Build on Windows 10/11 with WSL2
|
||||
|
||||
### Prerequisites
|
||||
|
||||
First, make sure your version of Windows 10 is new enough. Press **Win** + **R** to open the *Run* window and type in `winver` to check your Windows version and build number. The version should be **1903** or higher, the build number **18362** or higher.
|
||||
First, make sure your version of Windows 10 is new enough (any version of Windows 11 should be fine). Press **Win** + **R** to open the *Run* window and type in `winver` to check your Windows version and build number. The version should be **2004** or higher, the build number **19041** or higher.
|
||||
|
||||
#### Enabling Windows Features
|
||||
|
||||
|
||||
@@ -3,9 +3,9 @@
|
||||
You may now build your FunKey with:
|
||||
|
||||
```bash
|
||||
$ make sdk all
|
||||
$ make
|
||||
```
|
||||
This may take a while (~1h30), so consider getting yourself
|
||||
This may take a while (~30 minutes), so consider getting yourself
|
||||
a cup, a glass or a bottle of your favorite beverage ;-)
|
||||
|
||||
<ins>Note</ins>: you will need to have access to the network, since
|
||||
|
||||
@@ -58,7 +58,7 @@ $ mkdir images
|
||||
$ docker cp funkey-os:/home/funkey/FunKey-OS/images/FunKey-sdk-X.Y.Z.tar.gz images/
|
||||
```
|
||||
|
||||
[1]: https://github.com/FunKey-Project/FunKey-OS/releases/
|
||||
[1]: https://github.com/DrUm78/FunKey-OS/releases/
|
||||
[2]: ../compile_distribution
|
||||
|
||||
--8<--
|
||||
|
||||
@@ -5,7 +5,7 @@ When using either physical Linux machine or virtual Linux machines
|
||||
Github (here we place it into a `FunKey-OS` directory):
|
||||
|
||||
```bash
|
||||
$ git clone https://github.com/FunKey-Project/FunKey-OS.git FunKey-OS
|
||||
$ git clone https://github.com/DrUm78/FunKey-OS
|
||||
```
|
||||
|
||||
Then enter into the newly created directory:
|
||||
@@ -22,7 +22,7 @@ When using a Docker container, you must first create a new directory
|
||||
```bash
|
||||
$ mkdir FunKey-OS
|
||||
$ cd FunKey-OS
|
||||
$ wget https://raw.githubusercontent.com/FunKey-Project/FunKey-OS/master/docker/Dockerfile -o Dockerfile
|
||||
$ wget https://raw.githubusercontent.com/DrUm78/FunKey-OS/master/docker/Dockerfile -o Dockerfile
|
||||
```
|
||||
|
||||
You must then build the docker image (don't forget the final dot!):
|
||||
@@ -31,7 +31,7 @@ You must then build the docker image (don't forget the final dot!):
|
||||
$ docker build -t funkeyproject/funkey-os .
|
||||
```
|
||||
|
||||
[1]: https://github.com/FunKey-Project/FunKey-OS/blob/master/docker/Dockerfile
|
||||
[1]: https://github.com/DrUm78/FunKey-OS/blob/master/docker/Dockerfile
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
|
||||
@@ -36,7 +36,7 @@ to the [Buildroot Manual][7].
|
||||
|
||||
[1]: http://www.allwinnertech.com/index.php?c=product&a=index&id=38
|
||||
[2]: https://en.wikipedia.org/wiki/Cross_compiler
|
||||
[3]: https://github.com/FunKey-Project/FunKey-OS
|
||||
[3]: https://github.com/DrUm78/FunKey-OS
|
||||
[4]: https://www.funkey-project.com/
|
||||
[5]: http://nightly.buildroot.org/
|
||||
[6]: https://buildroot.org/downloads/manual/manual.html#outside-br-custom
|
||||
|
||||
Reference in New Issue
Block a user