mirror of
https://github.com/FunKey-Project/FunKey-Project.github.io.git
synced 2025-12-12 10:18:50 +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:
DrUm78
parent
71f1b6e877
commit
5cf1d247f4
@ -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
|
||||
|
||||
@ -17,7 +17,7 @@ The **FunKey S** operation is so straightforward that a 6-year old
|
||||
child should be able to operate it without any user's manual for the
|
||||
most common tasks. But just to make sure you are not missing
|
||||
something, you can find the basic device operation description in the
|
||||
[Quickstart section][1].
|
||||
[Tutorials section][1].
|
||||
|
||||
## More advanced features
|
||||
|
||||
@ -27,7 +27,7 @@ section][2].
|
||||
|
||||
## Developers
|
||||
|
||||
For developers, a full [Developer's Guide][3] is included, with both
|
||||
For developers, a full guide is included, with both
|
||||
[Hardware][3] and [Software][4] subsections.
|
||||
|
||||
|
||||
@ -43,12 +43,12 @@ For developers, a full [Developer's Guide][3] is included, with both
|
||||
## Miscellaenous stuff
|
||||
|
||||
Last but not least, this documentation would not be complete without a
|
||||
[Glossary of terms][5] and an [FAQ][6] section for reference.
|
||||
[Glossary of terms][5] for reference.
|
||||
|
||||
[1]: user_manual/quickstart.md
|
||||
[1]: user_manual/tutorials/software/add_roms.md
|
||||
[2]: user_manual/tutorials/software/firmware_update.md
|
||||
[3]: developer_guide/hardware_reference/
|
||||
[4]: developer_guide/software_reference/sd_card_layout/recovery_partition.md
|
||||
[4]: developer_guide/software_reference/
|
||||
[5]: miscellaneous/glossary.md
|
||||
[6]: miscellaneous/faq.md
|
||||
[7]: https://grabcad.com/library/funkey-s-1
|
||||
|
||||
@ -13,7 +13,7 @@ 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
|
||||
in the "assets" section:
|
||||
|
||||
[https://github.com/FunKey-Project/FunKey-OS/releases/latest][2]{target=_blank}
|
||||
[https://github.com/DrUm78/FunKey-OS/releases/latest][2]{target=_blank}
|
||||
|
||||
{.lightbox}
|
||||
|
||||
@ -123,8 +123,8 @@ Reassemble the console by following the previous steps in reverse order.
|
||||
Be careful not to damage the switches on the circuit board when
|
||||
putting back the L/R plastic buttons.
|
||||
|
||||
[1]: https://github.com/FunKey-Project/FunKey-OS/releases/download/FunKey-OS-2.3.0/FunKey-sdcard-2.3.0.img
|
||||
[2]: https://github.com/FunKey-Project/FunKey-OS/releases/latest
|
||||
[1]: https://github.com/DrUm78/FunKey-OS/releases/download/FunKey-OS-DrUm78/FunKey-sdcard-DrUm78.img
|
||||
[2]: https://github.com/DrUm78/FunKey-OS/releases/latest
|
||||
[3]: https://www.balena.io/etcher/
|
||||
[4]: #flashing-a-new-micro-sd-card
|
||||
|
||||
|
||||
@ -5,11 +5,11 @@ does not require installation to be able to run them.
|
||||
|
||||
!!! Note
|
||||
|
||||
In the current (2.0.0) release of the FunKey-OS, the **OPK** files
|
||||
are only available for the gmenu2x launcher, and not in RetroFE.
|
||||
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
|
||||
Creator (v1.1.2)][2] is a useful tool if you want to re-package an
|
||||
Creator][2] is a useful tool if you want to re-package an
|
||||
**OPK** or customize icons, add additional games and much more.
|
||||
|
||||
Connect your **FunKey S** console to your computer and add **OPK**
|
||||
@ -33,6 +33,7 @@ as you would do with a USB memory stick, too!
|
||||
|
||||
[1]: https://www.7-zip.org/download.html
|
||||
[2]: https://github.com/Harteex/OpenPackageCreator/releases
|
||||
[3]: https://github.com/DrUm78/FunKey-OS/releases/latest
|
||||
|
||||
[^1]: You can create additional 1st-level folders in order to organize your **OPK** files just like you want.
|
||||
|
||||
|
||||
@ -5,9 +5,7 @@ purchase and play famous ROMs legally such as Sonic, Castlevania,
|
||||
Megaman and more, read the note below for more details.
|
||||
|
||||
**The FunKey Wiki** maintains [lists][1]{target=_blank} of legal
|
||||
sources for ROMs, including [freeware ROMs][2]{target=_blank},
|
||||
[commercial ROMs][3]{target=_blank}, and
|
||||
[utilities][4]{target=_blank}.
|
||||
sources for ROMs, including [freeware ROMs][2]{target=_blank} and [commercial ROMs][3]{target=_blank}.
|
||||
|
||||
!!! note "Note about ROM emulation"
|
||||
|
||||
@ -42,7 +40,7 @@ as simply as you would do it with a simple USB memory stick:
|
||||
| {.lightbox} | Press the <i class="funkey-A"></i> key twice to confirm |
|
||||
| {.lightbox} | "**EJECT USB**" is now displayed instead, now go to your host computer and open a File Explorer window |
|
||||
| {.lightbox} | You should see the **FunKey S** appear as an USB drive on your computer in the File Explorer (example here with Windows 10) |
|
||||
| {.lightbox} | Drag & drop the ROM file and optional artwork file into the folder corresponding to the emulated console in this USB drive on your computer<br /><br />The artwork file must have the **same base name** as the ROM file with a _.png_ or _.jpg_ extension. It is recommended to resize the artwork to a maximum dimension of 240px (big files will make scrolling less fluid on the launcher)<br />An extensive **list of artwork files** (already resized to 240x240) has been made by Coolie Coolster <a href="https://drive.google.com/drive/folders/1UY4J8b6eMtG_IEtvHLOqGLm-DSgMkokA" target="_blank">here</a>. <br />An otherwise complete list of artwork can be found <a href="https://github.com/libretro-thumbnails/libretro-thumbnails" target="_blank">here</a>. |
|
||||
| {.lightbox} | Drag & drop the ROM file and optional artwork file into the folder corresponding to the emulated console in this USB drive on your computer<br /><br />The artwork file must have the **same base name** as the ROM file with a _.png_ or _.jpg_ extension. It is recommended to resize the artwork to a maximum dimension of 240px (big files will make scrolling less fluid on the launcher)<br />An extensive **list of artwork files** (already resized to 240x240) has been made by Coolie Coolster <a href="https://drive.google.com/drive/folders/1k55I5ig_wISP5RGjnH6K63H4LV9s-g3U" target="_blank">here</a>. <br />An otherwise complete list of artwork can be found <a href="https://github.com/libretro-thumbnails/libretro-thumbnails" target="_blank">here</a>. |
|
||||
| {.lightbox} | Eject cleanly the USB drive from your computer |
|
||||
| {.lightbox} | Back on the **FunKey S**, at the "**EJECT USB**" menu entry, press the <i class="funkey-A"></i> key twice to confirm |
|
||||
| {.lightbox} | Press the <i class="funkey-menu"></i> key to return to the launcher screen |
|
||||
|
||||
@ -5,7 +5,7 @@ Get the latest "**_FunKey-rootfs-x.y.z.fwu_**" firmware update file
|
||||
directly from [here][1] or from the bottom of the latest release page
|
||||
in the "assets" section:
|
||||
|
||||
[https://github.com/FunKey-Project/FunKey-OS/releases/latest][2]{target=_blank}
|
||||
[https://github.com/DrUm78/FunKey-OS/releases/latest][2]{target=_blank}
|
||||
|
||||
{.lightbox}
|
||||
|
||||
@ -22,8 +22,8 @@ in the "assets" section:
|
||||
| {.lightbox} | Back on the **FunKey S**, at the "**EJECT USB**" menu entry, press the <i class="funkey-A"></i> key twice to confirm |
|
||||
| {.lightbox} | The **FunKey S** will then reboot and perform the upgrade |
|
||||
|
||||
[1]: https://github.com/FunKey-Project/FunKey-OS/releases/download/FunKey-OS-2.3.0/FunKey-rootfs-2.3.0.fwu
|
||||
[2]: https://github.com/FunKey-Project/FunKey-OS/releases/latest
|
||||
[1]: https://github.com/DrUm78/FunKey-OS/releases/download/FunKey-OS-DrUm78/FunKey-rootfs-DrUm78.fwu
|
||||
[2]: https://github.com/DrUm78/FunKey-OS/releases/latest
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
|
||||
@ -44,6 +44,8 @@ file with the right name and size before you can actually play.
|
||||
|
||||
BIOS file name: SCPH1001.BIN
|
||||
|
||||
**Note: The BIOS location was recently moved to FunKey/.pcsx/bios, please read below.**
|
||||
|
||||
### Installation procedure
|
||||
|
||||
| **Display** | **Action** |
|
||||
@ -54,7 +56,7 @@ BIOS file name: SCPH1001.BIN
|
||||
| {.lightbox} | Press the <i class="funkey-A"></i> key twice to confirm |
|
||||
| {.lightbox} | "**EJECT USB**" is now displayed instead, now go to your host computer and open a File Explorer window |
|
||||
| {.lightbox} | You should see the **FunKey S** appear as an USB drive on your computer in the File Explorer (example here with Windows 10) |
|
||||
| {.lightbox} | Drag & drop the _**SCPH1001.BIN**_ BIOS file into the _**PS1/bios**_ folder in this USB drive on your computer |
|
||||
| {.lightbox} | Drag & drop the _**SCPH1001.BIN**_ BIOS file into the _**FunKey/.pcsx/bios**_ folder in this USB drive on your computer |
|
||||
| {.lightbox} | Eject cleanly the USB drive from your computer |
|
||||
| {.lightbox} | Back on the **FunKey S**, at the "**EJECT USB**" menu entry, press the <i class="funkey-A"></i> key twice to confirm |
|
||||
| {.lightbox} | Press the <i class="funkey-menu"></i> key to return to the launcher screen |
|
||||
|
||||
57
mkdocs.yml
57
mkdocs.yml
@ -7,14 +7,14 @@ site_name: FunKey Project Documentation
|
||||
site_url: "https://doc.funkey-project.com/"
|
||||
site_author: Michel Stempin
|
||||
site_description: >-
|
||||
FunKey S - the world's smallest foldable handeld console
|
||||
FunKey S - the world's smallest foldable handheld console
|
||||
Ultra-compact, foldable, powerful and comfortable, the FunKey S is
|
||||
the perfect handheld for playing retrogames anywhere, anytime.
|
||||
|
||||
# Copyright
|
||||
copyright: >
|
||||
© 2020-2022 FunKey Project<br/>
|
||||
Last updated on 2022-06-30<br/>
|
||||
© 2020-2023 FunKey Project<br/>
|
||||
Last updated on 2023-05-24<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
|
||||
@ -129,18 +129,18 @@ markdown_extensions:
|
||||
nav:
|
||||
- 'Overview': 'index.md'
|
||||
- "User's Manual":
|
||||
- 'Quickstart': 'user_manual/quickstart.md'
|
||||
- Product Description:
|
||||
- 'Key Mapping': 'user_manual/features/key_mapping.md'
|
||||
- 'Launchers': 'user_manual/features/launchers.md'
|
||||
- 'Emulators': 'user_manual/features/emulators.md'
|
||||
- 'Standalone Games & Applications': 'user_manual/features/games_apps.md'
|
||||
- 'FunKey Menu': 'user_manual/features/funkey_menu.md'
|
||||
- 'Folder Organization': 'user_manual/features/folder_organization.md'
|
||||
- 'Quick Save': 'user_manual/features/quick_save.md'
|
||||
- 'Instant Action': 'user_manual/features/instant_action.md'
|
||||
- 'Hardware Characteristics' : 'user_manual/features/hardware_characteristics.md'
|
||||
- 'Open Source' : 'user_manual/features/open_source.md'
|
||||
# - 'Quickstart': 'user_manual/quickstart.md'
|
||||
# - Product Description:
|
||||
# - 'Key Mapping': 'user_manual/features/key_mapping.md'
|
||||
# - 'Launchers': 'user_manual/features/launchers.md'
|
||||
# - 'Emulators': 'user_manual/features/emulators.md'
|
||||
# - 'Standalone Games & Applications': 'user_manual/features/games_apps.md'
|
||||
# - 'FunKey Menu': 'user_manual/features/funkey_menu.md'
|
||||
# - 'Folder Organization': 'user_manual/features/folder_organization.md'
|
||||
# - 'Quick Save': 'user_manual/features/quick_save.md'
|
||||
# - 'Instant Action': 'user_manual/features/instant_action.md'
|
||||
# - 'Hardware Characteristics' : 'user_manual/features/hardware_characteristics.md'
|
||||
# - 'Open Source' : 'user_manual/features/open_source.md'
|
||||
- Tutorials:
|
||||
- Software:
|
||||
- 'Add New ROMs': 'user_manual/tutorials/software/add_roms.md'
|
||||
@ -184,22 +184,23 @@ nav:
|
||||
- 'developer_guide/software_reference/boot_process/index.md'
|
||||
- 'Boot ROM': 'developer_guide/software_reference/boot_process/boot_rom.md'
|
||||
- 'SPL': 'developer_guide/software_reference/boot_process/spl.md'
|
||||
- 'U-Boot Bootloader': 'developer_guide/software_reference/boot_process/bootloader.md'
|
||||
- 'Linux Kernel': 'developer_guide/software_reference/boot_process/kernel.md'
|
||||
- 'System V Init Scripts': 'developer_guide/software_reference/boot_process/init_scripts.md'
|
||||
- 'Shutdown Process': 'developer_guide/software_reference/boot_process/shutdown_process.md'
|
||||
# - 'U-Boot Bootloader': 'developer_guide/software_reference/boot_process/bootloader.md'
|
||||
# - 'Linux Kernel': 'developer_guide/software_reference/boot_process/kernel.md'
|
||||
# - 'System V Init Scripts': 'developer_guide/software_reference/boot_process/init_scripts.md'
|
||||
# - 'Shutdown Process': 'developer_guide/software_reference/boot_process/shutdown_process.md'
|
||||
- SD-Card Layout:
|
||||
- 'developer_guide/software_reference/sd_card_layout/index.md'
|
||||
- 'Partition Map': 'developer_guide/software_reference/sd_card_layout/partition_map.md'
|
||||
- 'Recovery Partition': 'developer_guide/software_reference/sd_card_layout/recovery_partition.md'
|
||||
- 'Root Filesystem Partition': 'developer_guide/software_reference/sd_card_layout/root_filesystem_partition.md'
|
||||
- 'USB Shared Partition': 'developer_guide/software_reference/sd_card_layout/usb_shared_partition.md'
|
||||
- 'Video Processing': 'developer_guide/software_reference/video_processing.md'
|
||||
- 'Input Mapping': 'developer_guide/software_reference/input_mapping.md'
|
||||
- 'Directory Structure': 'developer_guide/software_reference/sd_card_layout/directory_structure.md'
|
||||
# - 'Partition Map': 'developer_guide/software_reference/sd_card_layout/partition_map.md'
|
||||
# - 'Recovery Partition': 'developer_guide/software_reference/sd_card_layout/recovery_partition.md'
|
||||
# - 'Root Filesystem Partition': 'developer_guide/software_reference/sd_card_layout/root_filesystem_partition.md'
|
||||
# - 'USB Shared Partition': 'developer_guide/software_reference/sd_card_layout/usb_shared_partition.md'
|
||||
# - 'Video Processing': 'developer_guide/software_reference/video_processing.md'
|
||||
# - 'Input Mapping': 'developer_guide/software_reference/input_mapping.md'
|
||||
- Tutorials:
|
||||
- 'Access the Recovery Boot Mode': 'developer_guide/tutorials/access_recovery.md'
|
||||
- 'SSH Connection over USB': 'developer_guide/tutorials/ssh_connection.md'
|
||||
- 'Serial Connection over UART': 'developer_guide/tutorials/uart_connection.md'
|
||||
# - 'SSH Connection over USB': 'developer_guide/tutorials/ssh_connection.md'
|
||||
# - 'Serial Connection over UART': 'developer_guide/tutorials/uart_connection.md'
|
||||
- Build System:
|
||||
- 'developer_guide/tutorials/build_system/index.md'
|
||||
- 'Compilation Environments': 'developer_guide/tutorials/build_system/compilation_environments.md'
|
||||
@ -211,5 +212,5 @@ nav:
|
||||
- '3D files': 'https://grabcad.com/library/funkey-s-1'
|
||||
- Miscellaneous:
|
||||
- 'Glossary': 'miscellaneous/glossary.md'
|
||||
- 'FAQ': 'miscellaneous/faq.md'
|
||||
# - 'FAQ': 'miscellaneous/faq.md'
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user