diff --git a/docs/developers/hardware_ref/architecture.md b/docs/developers/hardware_ref/architecture.md index 5c8e02e..cb112ff 100644 --- a/docs/developers/hardware_ref/architecture.md +++ b/docs/developers/hardware_ref/architecture.md @@ -14,15 +14,15 @@ to the following electronic diagram, featuring 3 main blocks: - 1x 420 mAh 402540 LiPo battery, containing an active protection circuitry -![FunKey S Block Diagram](/assets/images/FunKey_S_Block_Diagram.png){: .lightbox} +![FunKey S Block Diagram](/assets/images/FunKey_S_Block_Diagram.png){.lightbox} ## 3D View A 3D rendering of the PCBA done in KiCAD produces the images below: -![FunKey Top](/assets/images/FunKey_S_Top.png){: .lightbox} +![FunKey Top](/assets/images/FunKey_S_Top.png){.lightbox} -![FunKey Bottom](/assets/images/FunKey_S_Bottom.png){: .lightbox} +![FunKey Bottom](/assets/images/FunKey_S_Bottom.png){.lightbox} ## BOM diff --git a/docs/developers/hardware_ref/audio.md b/docs/developers/hardware_ref/audio.md index 48928e8..66b2600 100644 --- a/docs/developers/hardware_ref/audio.md +++ b/docs/developers/hardware_ref/audio.md @@ -53,7 +53,7 @@ required to drive the speaker. Here is the corresponding schematic: -![Audio Schematics](/assets/images/Audio_Schematics.png){: .lightbox} +![Audio Schematics](/assets/images/Audio_Schematics.png){.lightbox} We chose the right headphone channel HPOUTR that is fed to the audio amplifier **U2** through a coupling capacitor **C3**. diff --git a/docs/developers/hardware_ref/buttons.md b/docs/developers/hardware_ref/buttons.md index 237777b..c1cc5d1 100644 --- a/docs/developers/hardware_ref/buttons.md +++ b/docs/developers/hardware_ref/buttons.md @@ -76,7 +76,7 @@ when required. Here is the corresponding main schematic for the buttons: -![Main Button Schematics](/assets/images/Main_Button_Schematics.png){: .lightbox} +![Main Button Schematics](/assets/images/Main_Button_Schematics.png){.lightbox} The main component is of course the I/O expander **U1**, with the control signals to the CPU/PMIC on the north side. @@ -107,7 +107,7 @@ user! The other buttons are wired in the same fashion: -![Secondary Button Schematics](/assets/images/Secondary_Button_Schematics.png){: .lightbox} +![Secondary Button Schematics](/assets/images/Secondary_Button_Schematics.png){.lightbox} The "U", "L", "D", "R", "A", "B", "X" and "Y" buttons **S3**, **S4**, **S5**, **S6**, **S8**, **S9**, **S10** and **S11** are of the same diff --git a/docs/developers/hardware_ref/cpu.md b/docs/developers/hardware_ref/cpu.md index a965dc7..797d3a2 100644 --- a/docs/developers/hardware_ref/cpu.md +++ b/docs/developers/hardware_ref/cpu.md @@ -57,7 +57,7 @@ purpose. Here is the part of the schematics corresponding to the CPU core: -![CPU Schematics](/assets/images/CPU_Schematics.png){: .lightbox} +![CPU Schematics](/assets/images/CPU_Schematics.png){.lightbox} ## SoC Blocks @@ -192,13 +192,13 @@ termination resistors on the data lines DQx. DDR2 or DDR3 DRAMs feature merged drivers and dynamic on-chip termination like this ("VDDQ/2" is labeled "SVREF" in our schematic): -![DRAM Merged Drivers](/assets/images/DRAM_Merged_Drivers.png){: .lightbox} +![DRAM Merged Drivers](/assets/images/DRAM_Merged_Drivers.png){.lightbox} The V3s DDR2 DRAM has an active termination calibration circuitry and procedure called "_ZQ Calibration_" requiring an accurate 1% 240 Ω resistor **R11** connected internally like this: -![Pull-Up Calibration](/assets/images/Pull-Up_Calibration.png){: .lightbox} +![Pull-Up Calibration](/assets/images/Pull-Up_Calibration.png){.lightbox} More information on the DDR2 DRAM ZQ Calibration subject can be found in this [Micron Application Note][14]. diff --git a/docs/developers/hardware_ref/magnetic_switch.md b/docs/developers/hardware_ref/magnetic_switch.md index a94481c..f9c97e3 100644 --- a/docs/developers/hardware_ref/magnetic_switch.md +++ b/docs/developers/hardware_ref/magnetic_switch.md @@ -28,7 +28,7 @@ Meder MK24][1]. Here is the corresponding schematics, already covered in the PMIC discussion: -![Magnetic Sensor Schematics](/assets/images/Magnetic_Sensor_Schematics.png){: .lightbox} +![Magnetic Sensor Schematics](/assets/images/Magnetic_Sensor_Schematics.png){.lightbox} The global PMIC chip enable signal N_OE is activated by default through a 47kΩ resistor **R17** to GND, but the magnetic Reed switch diff --git a/docs/developers/hardware_ref/power/decoupling.md b/docs/developers/hardware_ref/power/decoupling.md index d9615bb..2aae6b8 100644 --- a/docs/developers/hardware_ref/power/decoupling.md +++ b/docs/developers/hardware_ref/power/decoupling.md @@ -97,7 +97,7 @@ are used for much lower currents and much briefer periods (typically The last part of the FunKey schematics merely contains only decoupling capacitors: -![Decoupling Schematics](/assets/images/Decoupling_Schematics.png){: .lightbox} +![Decoupling Schematics](/assets/images/Decoupling_Schematics.png){.lightbox} One exception is the Allwinner V3s CPU HPR/HPL circuit which features an RC-to-ground circuit between the amplifier and the preamplifier diff --git a/docs/developers/hardware_ref/power/dram.md b/docs/developers/hardware_ref/power/dram.md index 0861179..43a9a8e 100644 --- a/docs/developers/hardware_ref/power/dram.md +++ b/docs/developers/hardware_ref/power/dram.md @@ -19,7 +19,7 @@ Design][2]. Here is the corresponding DRAM Power schematics: -![DRAM Power Schematics](/assets/images/DRAM_Power_Schematics.png){: .lightbox} +![DRAM Power Schematics](/assets/images/DRAM_Power_Schematics.png){.lightbox} Nothing very fancy here: the SMPS chip **U4** has its required input filter capacitor **C37** and output capacitors **C65** and **C73**. diff --git a/docs/developers/hardware_ref/power/pmic.md b/docs/developers/hardware_ref/power/pmic.md index dbebf63..5a130e1 100644 --- a/docs/developers/hardware_ref/power/pmic.md +++ b/docs/developers/hardware_ref/power/pmic.md @@ -28,7 +28,7 @@ Their AXP20x products are highly-integrated PMICs that are optimized for applications requiring single-cell Li-battery (Li-Ion/Polymer), multiple output DC-DC converters and LDOs. Here is a block diagram: -![PMIC Block Diagram](/assets/images/AXP20x_Block_Diagram.png){: .lightbox} +![PMIC Block Diagram](/assets/images/AXP20x_Block_Diagram.png){.lightbox} The AXP20x features: @@ -88,7 +88,7 @@ schematics for using an AXP203 to supply the power to a V3s-based dashboard camera design. It follows closely the application diagram provided in the AXP20x datasheets: -![AXP20x Application Diagram](/assets/images/AXP20x_Application_Diagram.png){: .lightbox} +![AXP20x Application Diagram](/assets/images/AXP20x_Application_Diagram.png){.lightbox} More hints are provided in our self-translated [V3s Hardware Design Guide][10] (page 7) too. @@ -110,7 +110,7 @@ S** device only uses 2 out of the 5 integrated LDOs: Here are the PMIC schematics: -![PMIC Schematics](/assets/images/PMIC_Schematics.png){: .lightbox} +![PMIC Schematics](/assets/images/PMIC_Schematics.png){.lightbox} These schematics may look intimidating and complex, but they are in fact just a collection of simple basic elements, and it is actually diff --git a/docs/developers/hardware_ref/screen.md b/docs/developers/hardware_ref/screen.md index 9e523d3..47bd2c7 100644 --- a/docs/developers/hardware_ref/screen.md +++ b/docs/developers/hardware_ref/screen.md @@ -82,7 +82,7 @@ a one-time tooling fee of ~ $800. The schematic is quite simple: -![SPI LCD Schematics](/assets/images/SPI_LCD_Schematics.png){: .lightbox} +![SPI LCD Schematics](/assets/images/SPI_LCD_Schematics.png){.lightbox} The main component is of course the Hirose screen connector **J3**, with the following signals: @@ -120,7 +120,7 @@ the screen, we need to drive these LEDs "from the high-side", i.e. between the +3V3 power supply and the LEDA pin, so a MOSFET-P transistor is necessary: -![Backlight Schematics](/assets/images/Backlight_Schematics.png){: .lightbox} +![Backlight Schematics](/assets/images/Backlight_Schematics.png){.lightbox} As we want the backlight to be on by default, we need to drive it to GND by default: this is the role of **R7**. The role of **R5** is then diff --git a/docs/developers/hardware_ref/sd-card.md b/docs/developers/hardware_ref/sd-card.md index cf10e8d..bfe306d 100644 --- a/docs/developers/hardware_ref/sd-card.md +++ b/docs/developers/hardware_ref/sd-card.md @@ -26,7 +26,7 @@ But a good summary of the requirements is given in the "[AN10911 SD(HC)-memory card and MMC Interface conditioning][3]" application note from NXP, from which this schematic is taken: -![SD MMC Interface](/assets/images/SD_MMC_Interface.png){: .lightbox} +![SD MMC Interface](/assets/images/SD_MMC_Interface.png){.lightbox} !!! Warning This schematic does not include details concerning card-supply and @@ -80,7 +80,7 @@ an open-drain output mode, and its value should be undercut (down to The FunKey SD Card interface schematic is the following: -![SD Card Schematics](/assets/images/SD_Card_Schematics.png){: .lightbox} +![SD Card Schematics](/assets/images/SD_Card_Schematics.png){.lightbox} ![TF-110](/assets/images/TF-110.png){: align=left } diff --git a/docs/developers/hardware_ref/uart.md b/docs/developers/hardware_ref/uart.md index 5c301cf..3842042 100644 --- a/docs/developers/hardware_ref/uart.md +++ b/docs/developers/hardware_ref/uart.md @@ -12,7 +12,7 @@ loging into the system over an UART. The Console schematic only requires a minimum of external components: -![Console Schematics](/assets/images/UART_Schematics.png){: .lightbox} +![Console Schematics](/assets/images/UART_Schematics.png){.lightbox} Besides the 3-pin 1.27 mm (0.05") pitch header J1 that will not be mounted on standard products, there is only a single series resistor diff --git a/docs/developers/hardware_ref/usb.md b/docs/developers/hardware_ref/usb.md index 3294310..5f29ceb 100644 --- a/docs/developers/hardware_ref/usb.md +++ b/docs/developers/hardware_ref/usb.md @@ -22,7 +22,7 @@ user don't pull the chord straight. The USB schematic is the following: -![USB Schematics](/assets/images/USB_Schematics.png){: .lightbox} +![USB Schematics](/assets/images/USB_Schematics.png){.lightbox} Before connecting 2 devices using an USB cable, they may be at completely different absolute voltages, and during cable insertion, diff --git a/docs/tutorials/hardware/change_sd_card.md b/docs/tutorials/hardware/change_sd_card.md index 56cfb7f..855d75a 100644 --- a/docs/tutorials/hardware/change_sd_card.md +++ b/docs/tutorials/hardware/change_sd_card.md @@ -15,7 +15,7 @@ in the "assets" section: https://github.com/FunKey-Project/FunKey-OS/releases/latest{target=_blank} -![Github Release](/assets/images/github_sd_card_image.png){: .lightbox} +![Github Release](/assets/images/github_sd_card_image.png){.lightbox} ## Flash the micro-SD card with balenaEtcher @@ -35,7 +35,7 @@ https://github.com/FunKey-Project/FunKey-OS/releases/latest{target=_blank} will automatically unmount the SD card so it's safe to remove it from your computer. - ![balenaEtcher](/assets/images/Flashing_successful.png){: .lightbox} + ![balenaEtcher](/assets/images/Flashing_successful.png){.lightbox}
diff --git a/docs/tutorials/software/add_roms.md b/docs/tutorials/software/add_roms.md index ad86c0d..e30bcf6 100644 --- a/docs/tutorials/software/add_roms.md +++ b/docs/tutorials/software/add_roms.md @@ -33,18 +33,18 @@ sources for ROMs, including [freeware ROMs][2]{target=_blank}, Connect your **FunKey S** console to your computer and add new games as simply as you would do it with a simple USB memory stick: -| **Display** | **Action** | -| :-------------------------------------------------------------------------------: | :----------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| ![PC Connection](/assets/images/Connection_PC.png){: .lightbox} | Connect the **FunKey S** to your computer using the provided micro USB cable, then open it to turn it on | -| ![RetroFE](/assets/images/RetroFE.png){: .lightbox} | At the launcher's main screen (example here with RetroFE), press the key | -| ![Mount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the or keys until you see "**MOUNT USB**" | -| ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){: .lightbox} | Press the key twice to confirm | -| ![Eject USB](/assets/images/Eject_USB.png){: .lightbox} | "**EJECT USB**" is now displayed instead, now go to your host computer and open a File Explorer window | -| ![USB Drive](/assets/images/USB_Drive.png){: .lightbox} | You should see the **FunKey S** appear as an USB drive on your computer in the File Explorer (example here with Windows 10) | -| ![Copy ROM](/assets/images/Copy_ROM.png){: .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

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)
An extensive **list of artwork files** (already resized to 240x240) has been made by Coolie Coolster here.
An otherwise complete list of artwork can be found here. | -| ![Eject Drive](/assets/images/Eject_Drive.png){: .lightbox} | Eject cleanly the USB drive from your computer | -| ![Eject USB Are you sure](/assets/images/Eject_USB_are_you_sure.png){: .lightbox} | Back on the **FunKey S**, at the "**EJECT USB**" menu entry, press the key twice to confirm | -| ![Unmount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the key to return to the launcher screen | +| **Display** | **Action** | +| :-----------------------------------------------------------------------------: | :----------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ![PC Connection](/assets/images/Connection_PC.png){.lightbox} | Connect the **FunKey S** to your computer using the provided micro USB cable, then open it to turn it on | +| ![RetroFE](/assets/images/RetroFE.png){.lightbox} | At the launcher's main screen (example here with RetroFE), press the key | +| ![Mount USB](/assets/images/Mount_USB.png){.lightbox} | Press the or keys until you see "**MOUNT USB**" | +| ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){.lightbox} | Press the key twice to confirm | +| ![Eject USB](/assets/images/Eject_USB.png){.lightbox} | "**EJECT USB**" is now displayed instead, now go to your host computer and open a File Explorer window | +| ![USB Drive](/assets/images/USB_Drive.png){.lightbox} | You should see the **FunKey S** appear as an USB drive on your computer in the File Explorer (example here with Windows 10) | +| ![Copy ROM](/assets/images/Copy_ROM.png){.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

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)
An extensive **list of artwork files** (already resized to 240x240) has been made by Coolie Coolster here.
An otherwise complete list of artwork can be found here. | +| ![Eject Drive](/assets/images/Eject_Drive.png){.lightbox} | Eject cleanly the USB drive from your computer | +| ![Eject USB Are you sure](/assets/images/Eject_USB_are_you_sure.png){.lightbox} | Back on the **FunKey S**, at the "**EJECT USB**" menu entry, press the key twice to confirm | +| ![Unmount USB](/assets/images/Mount_USB.png){.lightbox} | Press the key to return to the launcher screen | Of course, you can remove games from the **FunKey S** console as you would do with a USB memory stick, too! diff --git a/docs/tutorials/software/aspect_ratio.md b/docs/tutorials/software/aspect_ratio.md index 1a8df63..af7b60c 100644 --- a/docs/tutorials/software/aspect_ratio.md +++ b/docs/tutorials/software/aspect_ratio.md @@ -34,12 +34,12 @@ display aspect ratio: - Use the and keys to change the aspect ratio -| **Display** | **Aspect Ratio** | -|:---------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------| -| ![Menu Stretched](/assets/images/Menu_Stretched.png){: .lightbox} | Stretched (default): The display is stretched horizontally and vertically to fill the screen in both directions | -| ![Menu Cropped](/assets/images/Menu_Cropped.png){: .lightbox} | Cropped (Zoom 100%), The display fills the screen vertically, and is clipped vertically to the left and right of the screen | -| ![Menu Scaled](/assets/images/Menu_Scaled.png){: .lightbox} | Scaled (Zoom 0%): The display is scaled down in both directions to be fully visible, both horizontally and vertically | -| ![Menu Manual Zoom](/assets/images/Menu_Manual_Zoom.png){: .lightbox} | Manual zoom: The display is zoomed in/out manually | +| **Display** | **Aspect Ratio** | +|:-------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------| +| ![Menu Stretched](/assets/images/Menu_Stretched.png){.lightbox} | Stretched (default): The display is stretched horizontally and vertically to fill the screen in both directions | +| ![Menu Cropped](/assets/images/Menu_Cropped.png){.lightbox} | Cropped (Zoom 100%), The display fills the screen vertically, and is clipped vertically to the left and right of the screen | +| ![Menu Scaled](/assets/images/Menu_Scaled.png){.lightbox} | Scaled (Zoom 0%): The display is scaled down in both directions to be fully visible, both horizontally and vertically | +| ![Menu Manual Zoom](/assets/images/Menu_Manual_Zoom.png){.lightbox} | Manual zoom: The display is zoomed in/out manually | - Press the key again to exit from the FunKey menu @@ -48,22 +48,22 @@ display aspect ratio: Here is a short preview of what the different aspect ratios look like: -| **Display** | **Aspect Ratio** | -|:-------------------------------------------------------:|:-----------------------------------------------------------------------------------------------------------------------------------| -| ![Stretched](/assets/images/Stretched.png){: .lightbox} | Stretched (default): The display is stretched horizontally and vertically to fill the screen in both directions | -| ![Cropped](/assets/images/Cropped.png){: .lightbox} | Cropped (Zoom 100%): The display fills the screen vertically, and is clipped vertically to the left and right of the screen | -| ![Scaled](/assets/images/Scaled.png){: .lightbox} | Scaled (Zoom 0%): The display is scaled down in both directions to be fully visible, both horizontally and vertically | -| ![Scaled](/assets/images/Scaled.png){: .lightbox} | Manual zoom 0% (Scaled): The display is scaled down in both directions to be fully visible, both horizontally and vertically | -| ![Zoom 10%](/assets/images/Zoom10.png){: .lightbox} | Manual zoom 10% | -| ![Zoom 20%](/assets/images/Zoom20.png){: .lightbox} | Manual zoom 20% | -| ![Zoom 30%](/assets/images/Zoom30.png){: .lightbox} | Manual zoom 30% | -| ![Zoom 40%](/assets/images/Zoom40.png){: .lightbox} | Manual zoom 40% | -| ![Zoom 50%](/assets/images/Zoom50.png){: .lightbox} | Manual zoom 50% (default zoom level) | -| ![Zoom 60%](/assets/images/Zoom60.png){: .lightbox} | Manual zoom 60% | -| ![Zoom 70%](/assets/images/Zoom70.png){: .lightbox} | Manual zoom 70% | -| ![Zoom 80%](/assets/images/Zoom80.png){: .lightbox} | Manual zoom 80% | -| ![Zoom 90%](/assets/images/Zoom90.png){: .lightbox} | Manual zoom 90% | -| ![Cropped](/assets/images/Cropped.png){: .lightbox} | Manual zoom 100% (Cropped): The display fills the screen vertically, and is clipped vertically to the left and right of the screen | +| **Display** | **Aspect Ratio** | +|:-----------------------------------------------------:|:-----------------------------------------------------------------------------------------------------------------------------------| +| ![Stretched](/assets/images/Stretched.png){.lightbox} | Stretched (default): The display is stretched horizontally and vertically to fill the screen in both directions | +| ![Cropped](/assets/images/Cropped.png){.lightbox} | Cropped (Zoom 100%): The display fills the screen vertically, and is clipped vertically to the left and right of the screen | +| ![Scaled](/assets/images/Scaled.png){.lightbox} | Scaled (Zoom 0%): The display is scaled down in both directions to be fully visible, both horizontally and vertically | +| ![Scaled](/assets/images/Scaled.png){.lightbox} | Manual zoom 0% (Scaled): The display is scaled down in both directions to be fully visible, both horizontally and vertically | +| ![Zoom 10%](/assets/images/Zoom10.png){.lightbox} | Manual zoom 10% | +| ![Zoom 20%](/assets/images/Zoom20.png){.lightbox} | Manual zoom 20% | +| ![Zoom 30%](/assets/images/Zoom30.png){.lightbox} | Manual zoom 30% | +| ![Zoom 40%](/assets/images/Zoom40.png){.lightbox} | Manual zoom 40% | +| ![Zoom 50%](/assets/images/Zoom50.png){.lightbox} | Manual zoom 50% (default zoom level) | +| ![Zoom 60%](/assets/images/Zoom60.png){.lightbox} | Manual zoom 60% | +| ![Zoom 70%](/assets/images/Zoom70.png){.lightbox} | Manual zoom 70% | +| ![Zoom 80%](/assets/images/Zoom80.png){.lightbox} | Manual zoom 80% | +| ![Zoom 90%](/assets/images/Zoom90.png){.lightbox} | Manual zoom 90% | +| ![Cropped](/assets/images/Cropped.png){.lightbox} | Manual zoom 100% (Cropped): The display fills the screen vertically, and is clipped vertically to the left and right of the screen | --8<-- includes/glossary.md diff --git a/docs/tutorials/software/copy_opk.md b/docs/tutorials/software/copy_opk.md index 083bcf9..759b385 100644 --- a/docs/tutorials/software/copy_opk.md +++ b/docs/tutorials/software/copy_opk.md @@ -15,18 +15,18 @@ Creator (v1.1.2)][2] is a useful tool if you want to re-package an Connect your **FunKey S** console to your computer and add **OPK** files as simply as you would do it with a simple USB memory stick: -| **Display** | **Action** | -|:-----------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------| -| ![Connection PC](/assets/images/Connection_PC.png){: .lightbox} | Connect the **FunKey S** to your computer using the provided micro USB cable, then open it to turn it on | -| ![RetroFE](/assets/images/gmenu2x.png){: .lightbox} | At the launcher's main screen (example here with gmenu2x), press the key | -| ![Mount USB](/assets/images/Mount_USB_gmenu2x.png){: .lightbox} | Press the or keys until you see "**MOUNT USB**" | -| ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure_gmenu2x.png){: .lightbox} | Press the key twice to confirm | -| ![Eject USB](/assets/images/Eject_USB_gmenu2x.png){: .lightbox} | "**EJECT USB**" is now displayed instead, now go to your host computer and open a File Explorer window | -| ![USB Drive](/assets/images/USB_Drive.png){: .lightbox} | You should see the **FunKey S** appear as an USB drive on your computer in the File Explorer (example here with Windows 10) | -| ![Copy OPK](/assets/images/Copy_OPK.png){: .lightbox} | Drag & drop the **OPK** file into any 1st-level folder[^1] in this USB drive on your computer and they will be automatically available on the **FunKey S** | -| ![Eject Drive](/assets/images/Eject_Drive.png){: .lightbox} | Eject cleanly the USB drive from your computer | -| ![Eject USB Are you sure](/assets/images/Eject_USB_are_you_sure_gmenu2x.png){: .lightbox} | Back on the **FunKey S**, at the "**EJECT USB**" menu entry, press the key twice to confirm | -| ![Unmount USB](/assets/images/Mount_USB_gmenu2x.png){: .lightbox} | Press the key to return to the launcher screen | +| **Display** | **Action** | +|:---------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ![Connection PC](/assets/images/Connection_PC.png){.lightbox} | Connect the **FunKey S** to your computer using the provided micro USB cable, then open it to turn it on | +| ![RetroFE](/assets/images/gmenu2x.png){.lightbox} | At the launcher's main screen (example here with gmenu2x), press the key | +| ![Mount USB](/assets/images/Mount_USB_gmenu2x.png){.lightbox} | Press the or keys until you see "**MOUNT USB**" | +| ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure_gmenu2x.png){.lightbox} | Press the key twice to confirm | +| ![Eject USB](/assets/images/Eject_USB_gmenu2x.png){.lightbox} | "**EJECT USB**" is now displayed instead, now go to your host computer and open a File Explorer window | +| ![USB Drive](/assets/images/USB_Drive.png){.lightbox} | You should see the **FunKey S** appear as an USB drive on your computer in the File Explorer (example here with Windows 10) | +| ![Copy OPK](/assets/images/Copy_OPK.png){.lightbox} | Drag & drop the **OPK** file into any 1st-level folder[^1] in this USB drive on your computer and they will be automatically available on the **FunKey S** | +| ![Eject Drive](/assets/images/Eject_Drive.png){.lightbox} | Eject cleanly the USB drive from your computer | +| ![Eject USB Are you sure](/assets/images/Eject_USB_are_you_sure_gmenu2x.png){.lightbox} | Back on the **FunKey S**, at the "**EJECT USB**" menu entry, press the key twice to confirm | +| ![Unmount USB](/assets/images/Mount_USB_gmenu2x.png){.lightbox} | Press the key to return to the launcher screen | Of course, you can remove **OPK** files from the **FunKey S** console as you would do with a USB memory stick, too! diff --git a/docs/tutorials/software/gb_palette.md b/docs/tutorials/software/gb_palette.md index 97064a7..0a3b97b 100644 --- a/docs/tutorials/software/gb_palette.md +++ b/docs/tutorials/software/gb_palette.md @@ -117,21 +117,21 @@ set dmg_obp1 0xc0ffff 0x408080 0x204040 0x000000` # Changing the palette -| **Display** | **Action** | -| :-------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------| -| ![Connection PC](/assets/images/Connection_PC.png){: .lightbox} | Connect the **FunKey S** to your computer using the provided micro USB cable, then open it to turn it on | -| ![RetroFE](/assets/images/RetroFE.png){: .lightbox} | At the launcher's main screen (example here with RetroFE), press the key | -| ![Mount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the or keys until you see "**MOUNT USB**" | -| ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){: .lightbox} | Press the key twice to confirm | -| ![Eject USB](/assets/images/Eject_USB.png){: .lightbox} | "**EJECT USB**" is now displayed instead, now go to your host computer and open a File Explorer window | -| ![USB Drive](/assets/images/USB_Drive.png){: .lightbox} | You should see the **FunKey S** appear as an USB drive on your computer in the File Explorer (example here with Windows 10) | -| ![create _gnuboy](/assets/images/create_gnuboy_folder.png){: .lightbox} | In the FunKey folder, create a new folder .gnuboy if it does not already exist. | -| ![create gnuboy_rc](/assets/images/create_gnuboy_rc_file.png){: .lightbox} | In the FunKey/.gnuboy folder create a file gnuboy.rc if it does not already exist. | -| ![modify gnuboy_rc](/assets/images/set_palette.png){: .lightbox} | Open the gnuboy.rc file with a text editor and add the palette you want. | -| ![Eject Drive](/assets/images/Eject_Drive.png){: .lightbox} | Eject cleanly the USB drive from your computer | -| ![Eject USB Are you sure](/assets/images/Eject_USB_are_you_sure.png){: .lightbox} | Back on the **FunKey S**, at the "**EJECT USB**" menu entry, press the key twice to confirm | -| ![Unmount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the key to return to the launcher screen | -| ![palette results](/assets/images/results_palette.png){: .lightbox} | Launch any Gameboy game to see the results of your new palette settings. | +| **Display** | **Action** | +| :-----------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------| +| ![Connection PC](/assets/images/Connection_PC.png){.lightbox} | Connect the **FunKey S** to your computer using the provided micro USB cable, then open it to turn it on | +| ![RetroFE](/assets/images/RetroFE.png){.lightbox} | At the launcher's main screen (example here with RetroFE), press the key | +| ![Mount USB](/assets/images/Mount_USB.png){.lightbox} | Press the or keys until you see "**MOUNT USB**" | +| ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){.lightbox} | Press the key twice to confirm | +| ![Eject USB](/assets/images/Eject_USB.png){.lightbox} | "**EJECT USB**" is now displayed instead, now go to your host computer and open a File Explorer window | +| ![USB Drive](/assets/images/USB_Drive.png){.lightbox} | You should see the **FunKey S** appear as an USB drive on your computer in the File Explorer (example here with Windows 10) | +| ![create _gnuboy](/assets/images/create_gnuboy_folder.png){.lightbox} | In the FunKey folder, create a new folder .gnuboy if it does not already exist. | +| ![create gnuboy_rc](/assets/images/create_gnuboy_rc_file.png){.lightbox} | In the FunKey/.gnuboy folder create a file gnuboy.rc if it does not already exist. | +| ![modify gnuboy_rc](/assets/images/set_palette.png){.lightbox} | Open the gnuboy.rc file with a text editor and add the palette you want. | +| ![Eject Drive](/assets/images/Eject_Drive.png){.lightbox} | Eject cleanly the USB drive from your computer | +| ![Eject USB Are you sure](/assets/images/Eject_USB_are_you_sure.png){.lightbox} | Back on the **FunKey S**, at the "**EJECT USB**" menu entry, press the key twice to confirm | +| ![Unmount USB](/assets/images/Mount_USB.png){.lightbox} | Press the key to return to the launcher screen | +| ![palette results](/assets/images/results_palette.png){.lightbox} | Launch any Gameboy game to see the results of your new palette settings. | [1]: https://github.com/rofl0r/gnuboy diff --git a/docs/tutorials/software/gba_bios.md b/docs/tutorials/software/gba_bios.md index 4de13bf..a0ddc2b 100644 --- a/docs/tutorials/software/gba_bios.md +++ b/docs/tutorials/software/gba_bios.md @@ -19,18 +19,18 @@ actually play. ### Installation procedure -| **Display** | **Action** | -|:---------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------| -| ![Connection PC](/assets/images/Connection_PC.png){: .lightbox} | Connect the **FunKey S** to your computer using the provided micro USB cable, then open it to turn it on | -| ![RetroFE](/assets/images/RetroFE.png){: .lightbox} | At the launcher's main screen (example here with RetroFE), press the key | -| ![Mount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the or keys until you see "**MOUNT USB**" | -| ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){: .lightbox} | Press the key twice to confirm | -| ![Eject USB](/assets/images/Eject_USB.png){: .lightbox} | "**EJECT USB**" is now displayed instead, now go to your host computer and open a File Explorer window | -| ![USB Drive](/assets/images/USB_Drive.png){: .lightbox} | You should see the **FunKey S** appear as an USB drive on your computer in the File Explorer (example here with Windows 10) | -| ![Copy ROM](/assets/images/Copy_GBA_BIOS.png){: .lightbox} | Drag & drop the _**gba_bios.bin**_ BIOS file into the _**Game Boy Advance**_ folder in this USB drive on your computer | -| ![Eject Drive](/assets/images/Eject_Drive.png){: .lightbox} | Eject cleanly the USB drive from your computer | -| ![Eject USB Are you sure](/assets/images/Eject_USB_are_you_sure.png){: .lightbox} | Back on the **FunKey S**, at the "**EJECT USB**" menu entry, press the key twice to confirm | -| ![Unmount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the key to return to the launcher screen | +| **Display** | **Action** | +|:-------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------| +| ![Connection PC](/assets/images/Connection_PC.png){.lightbox} | Connect the **FunKey S** to your computer using the provided micro USB cable, then open it to turn it on | +| ![RetroFE](/assets/images/RetroFE.png){.lightbox} | At the launcher's main screen (example here with RetroFE), press the key | +| ![Mount USB](/assets/images/Mount_USB.png){.lightbox} | Press the or keys until you see "**MOUNT USB**" | +| ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){.lightbox} | Press the key twice to confirm | +| ![Eject USB](/assets/images/Eject_USB.png){.lightbox} | "**EJECT USB**" is now displayed instead, now go to your host computer and open a File Explorer window | +| ![USB Drive](/assets/images/USB_Drive.png){.lightbox} | You should see the **FunKey S** appear as an USB drive on your computer in the File Explorer (example here with Windows 10) | +| ![Copy ROM](/assets/images/Copy_GBA_BIOS.png){.lightbox} | Drag & drop the _**gba_bios.bin**_ BIOS file into the _**Game Boy Advance**_ folder in this USB drive on your computer | +| ![Eject Drive](/assets/images/Eject_Drive.png){.lightbox} | Eject cleanly the USB drive from your computer | +| ![Eject USB Are you sure](/assets/images/Eject_USB_are_you_sure.png){.lightbox} | Back on the **FunKey S**, at the "**EJECT USB**" menu entry, press the key twice to confirm | +| ![Unmount USB](/assets/images/Mount_USB.png){.lightbox} | Press the key to return to the launcher screen | ## PS1 @@ -46,18 +46,18 @@ BIOS file name: SCPH1001.BIN ### Installation procedure -| **Display** | **Action** | -|:---------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------| -| ![Connection PC](/assets/images/Connection_PC.png){: .lightbox} | Connect the **FunKey S** to your computer using the provided micro USB cable, then open it to turn it on | -| ![RetroFE](/assets/images/RetroFE.png){: .lightbox} | At the launcher's main screen (example here with RetroFE), press the | -| ![Mount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the or keys until you see "**MOUNT USB**" | -| ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){: .lightbox} | Press the key twice to confirm | -| ![Eject USB](/assets/images/Eject_USB.png){: .lightbox} | "**EJECT USB**" is now displayed instead, now go to your host computer and open a File Explorer window | -| ![USB Drive](/assets/images/USB_Drive.png){: .lightbox} | You should see the **FunKey S** appear as an USB drive on your computer in the File Explorer (example here with Windows 10) | -| ![Copy ROM](/assets/images/Copy_PS1_BIOS.png){: .lightbox} | Drag & drop the _**SCPH1001.BIN**_ BIOS file into the _**PS1/bios**_ folder in this USB drive on your computer | -| ![Eject Drive](/assets/images/Eject_Drive.png){: .lightbox} | Eject cleanly the USB drive from your computer | -| ![Eject USB Are you sure](/assets/images/Eject_USB_are_you_sure.png){: .lightbox} | Back on the **FunKey S**, at the "**EJECT USB**" menu entry, press the key twice to confirm | -| ![Unmount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the key to return to the launcher screen | +| **Display** | **Action** | +|:-------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------| +| ![Connection PC](/assets/images/Connection_PC.png){.lightbox} | Connect the **FunKey S** to your computer using the provided micro USB cable, then open it to turn it on | +| ![RetroFE](/assets/images/RetroFE.png){.lightbox} | At the launcher's main screen (example here with RetroFE), press the | +| ![Mount USB](/assets/images/Mount_USB.png){.lightbox} | Press the or keys until you see "**MOUNT USB**" | +| ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){.lightbox} | Press the key twice to confirm | +| ![Eject USB](/assets/images/Eject_USB.png){.lightbox} | "**EJECT USB**" is now displayed instead, now go to your host computer and open a File Explorer window | +| ![USB Drive](/assets/images/USB_Drive.png){.lightbox} | You should see the **FunKey S** appear as an USB drive on your computer in the File Explorer (example here with Windows 10) | +| ![Copy ROM](/assets/images/Copy_PS1_BIOS.png){.lightbox} | Drag & drop the _**SCPH1001.BIN**_ BIOS file into the _**PS1/bios**_ folder in this USB drive on your computer | +| ![Eject Drive](/assets/images/Eject_Drive.png){.lightbox} | Eject cleanly the USB drive from your computer | +| ![Eject USB Are you sure](/assets/images/Eject_USB_are_you_sure.png){.lightbox} | Back on the **FunKey S**, at the "**EJECT USB**" menu entry, press the key twice to confirm | +| ![Unmount USB](/assets/images/Mount_USB.png){.lightbox} | Press the key to return to the launcher screen | --8<-- includes/glossary.md diff --git a/docs/tutorials/software/snapshot.md b/docs/tutorials/software/snapshot.md index 5765560..e1211e5 100644 --- a/docs/tutorials/software/snapshot.md +++ b/docs/tutorials/software/snapshot.md @@ -8,18 +8,18 @@ the host computer and they will be numbered following a In order to access the snapshots, follow these simple steps: -| **Display** | **Action** | -|:---------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------| -| ![Connection PC](/assets/images/Connection_PC.png){: .lightbox} | Connect the **FunKey S** to your computer using the provided micro USB cable, then open it to turn it on | -| ![RetroFE](/assets/images/RetroFE.png){: .lightbox} | At the launcher's main screen (example here with RetroFE), press the key | -| ![Mount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the or keys until you see "**MOUNT USB**" | -| ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){: .lightbox} | Press the key twice to confirm | -| ![Eject USB](/assets/images/Eject_USB.png){: .lightbox} | "**EJECT USB**" is now displayed instead, now go to your host computer and open a File Explorer window | -| ![USB Drive](/assets/images/USB_Drive.png){: .lightbox} | You should see the **FunKey S** appear as an USB drive on your computer in the File Explorer (example here with Windows 10) | -| ![Copy ROM](/assets/images/Snapshots.png){: .lightbox} | Drag & drop / Copy / Move / Delete the snapshots files from the _FunKey/snapshots/_ folder in this USB drive on your computer as required | -| ![Eject Drive](/assets/images/Eject_Drive.png){: .lightbox} | Eject cleanly the USB drive from your computer | -| ![Eject USB Are you sure](/assets/images/Eject_USB_are_you_sure.png){: .lightbox} | Back on the **FunKey S**, at the "**EJECT USB**" menu entry, press the key twice to confirm | -| ![Unmount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the key to return to the launcher screen | +| **Display** | **Action** | +|:-------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------| +| ![Connection PC](/assets/images/Connection_PC.png){.lightbox} | Connect the **FunKey S** to your computer using the provided micro USB cable, then open it to turn it on | +| ![RetroFE](/assets/images/RetroFE.png){.lightbox} | At the launcher's main screen (example here with RetroFE), press the key | +| ![Mount USB](/assets/images/Mount_USB.png){.lightbox} | Press the or keys until you see "**MOUNT USB**" | +| ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){.lightbox} | Press the key twice to confirm | +| ![Eject USB](/assets/images/Eject_USB.png){.lightbox} | "**EJECT USB**" is now displayed instead, now go to your host computer and open a File Explorer window | +| ![USB Drive](/assets/images/USB_Drive.png){.lightbox} | You should see the **FunKey S** appear as an USB drive on your computer in the File Explorer (example here with Windows 10) | +| ![Copy ROM](/assets/images/Snapshots.png){.lightbox} | Drag & drop / Copy / Move / Delete the snapshots files from the _FunKey/snapshots/_ folder in this USB drive on your computer as required | +| ![Eject Drive](/assets/images/Eject_Drive.png){.lightbox} | Eject cleanly the USB drive from your computer | +| ![Eject USB Are you sure](/assets/images/Eject_USB_are_you_sure.png){.lightbox} | Back on the **FunKey S**, at the "**EJECT USB**" menu entry, press the key twice to confirm | +| ![Unmount USB](/assets/images/Mount_USB.png){.lightbox} | Press the key to return to the launcher screen | --8<-- includes/glossary.md diff --git a/docs/tutorials/software/update.md b/docs/tutorials/software/update.md index d376458..bb767b7 100644 --- a/docs/tutorials/software/update.md +++ b/docs/tutorials/software/update.md @@ -7,20 +7,20 @@ in the "assets" section: https://github.com/FunKey-Project/FunKey-OS/releases/latest -![Github Release](/assets/images/Github_Release.png){: .lightbox} +![Github Release](/assets/images/Github_Release.png){.lightbox} -| **Display** | **Action** | -|:---------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------| -| ![Connection PC](/assets/images/Connection_PC.png){: .lightbox} | Connect the **FunKey S** to your computer using the provided micro USB cable, then open it to turn it on | -| ![RetroFE](/assets/images/RetroFE.png){: .lightbox} | At the launcher's main screen (example here with RetroFE), press the key | -| ![Mount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the or keys until you see "**MOUNT USB**" | -| ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){: .lightbox} | Press the key twice to confirm | -| ![Eject USB](/assets/images/Eject_USB.png){: .lightbox} | "**EJECT USB**" is now displayed instead, now go to your host computer and open a File Explorer window | -| ![USB Drive](/assets/images/USB_Drive.png){: .lightbox} | You should see the **FunKey S** appear as an USB drive on your computer in the File Explorer (example here with Windows 10) | -| ![USB Drag and Drop](/assets/images/USB_Drag_Drop.png){: .lightbox} | Drag & drop the _FunKey-roots-2.0.0.fwu_ file you just downloaded at the root of this USB drive on your computer | -| ![Eject Drive](/assets/images/Eject_Drive.png){: .lightbox} | Eject cleanly the USB drive from your computer | -| ![Eject USB Are you sure](/assets/images/Eject_USB_are_you_sure.png){: .lightbox} | Back on the **FunKey S**, at the "**EJECT USB**" menu entry, press the key twice to confirm | -| ![Updating](/assets/images/Updating.png){: .lightbox} | The **FunKey S** will then reboot and perform the upgrade | +| **Display** | **Action** | +|:-------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------| +| ![Connection PC](/assets/images/Connection_PC.png){.lightbox} | Connect the **FunKey S** to your computer using the provided micro USB cable, then open it to turn it on | +| ![RetroFE](/assets/images/RetroFE.png){.lightbox} | At the launcher's main screen (example here with RetroFE), press the key | +| ![Mount USB](/assets/images/Mount_USB.png){.lightbox} | Press the or keys until you see "**MOUNT USB**" | +| ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){.lightbox} | Press the key twice to confirm | +| ![Eject USB](/assets/images/Eject_USB.png){.lightbox} | "**EJECT USB**" is now displayed instead, now go to your host computer and open a File Explorer window | +| ![USB Drive](/assets/images/USB_Drive.png){.lightbox} | You should see the **FunKey S** appear as an USB drive on your computer in the File Explorer (example here with Windows 10) | +| ![USB Drag and Drop](/assets/images/USB_Drag_Drop.png){.lightbox} | Drag & drop the _FunKey-roots-2.0.0.fwu_ file you just downloaded at the root of this USB drive on your computer | +| ![Eject Drive](/assets/images/Eject_Drive.png){.lightbox} | Eject cleanly the USB drive from your computer | +| ![Eject USB Are you sure](/assets/images/Eject_USB_are_you_sure.png){.lightbox} | Back on the **FunKey S**, at the "**EJECT USB**" menu entry, press the key twice to confirm | +| ![Updating](/assets/images/Updating.png){.lightbox} | The **FunKey S** will then reboot and perform the upgrade | [1]: https://github.com/FunKey-Project/FunKey-OS/releases/download/FunKey-OS-2.0.0/FunKey-rootfs-2.0.0.fwu