Skip to content
This repository has been archived by the owner on May 8, 2024. It is now read-only.

Commit

Permalink
First iteration of automated documentation for supported emulators an…
Browse files Browse the repository at this point in the history 
…d cores complete and generated.
  • Loading branch information
fewtarius committed Jul 14, 2023
1 parent 2aaacd3 commit b6a8037
Show file tree
Hide file tree
Showing 10 changed files with 723 additions and 175 deletions.
19 changes: 10 additions & 9 deletions .github/workflows/build-main.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,15 +98,15 @@ jobs:
* Write the image to an SDCARD using an imaging tool. Common imaging tools include [Balena Etcher](https://www.balena.io/etcher/), [Raspberry Pi Imager](https://www.raspberrypi.com/software/), and [Win32 Disk Imager](https://sourceforge.net/projects/win32diskimager/). If you're skilled with the command line, dd works fine too.
### Installation Package Downloads
|**Device/Platform**|**Download Package**|
|----|----|
|**Anbernic RG351P/M, ODROID Go Advance, ODROID Go Super**|[JELOS-RK3326.aarch64-${{ steps.version.outputs.version }}.img.gz](https://github.com/JustEnoughLinuxOS/distribution/releases/download/${{ steps.version.outputs.version }}/JELOS-RK3326.aarch64-${{ steps.version.outputs.version }}.img.gz)|
|**Anbernic RG353P/M/V/VS, RG503, and Powkiddy RK2023**|[JELOS-RK3566.aarch64-${{ steps.version.outputs.version }}.img.gz](https://github.com/JustEnoughLinuxOS/distribution/releases/download/${{ steps.version.outputs.version }}/JELOS-RK3566.aarch64-${{ steps.version.outputs.version }}.img.gz)|
|**Anbernic RG552**|[JELOS-RK3399.aarch64-${{ steps.version.outputs.version }}.img.gz](https://github.com/JustEnoughLinuxOS/distribution/releases/download/${{ steps.version.outputs.version }}/JELOS-RK3399.aarch64-${{ steps.version.outputs.version }}.img.gz)|
|**Ayaneo Handhelds, Atari VCS, and other x86_64 devices**|[JELOS-AMD64.x86_64-${{ steps.version.outputs.version }}.img.gz](https://github.com/JustEnoughLinuxOS/distribution/releases/download/${{ steps.version.outputs.version }}/JELOS-AMD64.x86_64-${{ steps.version.outputs.version }}.img.gz)|
|**Hardkernel ODROID Go Ultra, Powkiddy RGB10 Max 3 Pro**|[JELOS-S922X.aarch64-${{ steps.version.outputs.version }}.img.gz](https://github.com/JustEnoughLinuxOS/distribution/releases/download/${{ steps.version.outputs.version }}/JELOS-S922X.aarch64-${{ steps.version.outputs.version }}.img.gz)|
|**Orange Pi 5, and Indiedroid Nova**|[JELOS-RK3588.aarch64-${{ steps.version.outputs.version }}.img.gz](https://github.com/JustEnoughLinuxOS/distribution/releases/download/${{ steps.version.outputs.version }}/JELOS-RK3588.aarch64-${{ steps.version.outputs.version }}.img.gz)|
|**Powkiddy x55**|[JELOS-RK3566-X55.aarch64-${{ steps.version.outputs.version }}.img.gz](https://github.com/JustEnoughLinuxOS/distribution/releases/download/${{ steps.version.outputs.version }}/JELOS-RK3566-X55.aarch64-${{ steps.version.outputs.version }}.img.gz)|
|**Device/Platform**|**Download Package**|**Documentation**|
|----|----|----|
|**Anbernic RG351P/M, ODROID Go Advance, ODROID Go Super**|[JELOS-RK3326.aarch64-${{ steps.version.outputs.version }}.img.gz](https://github.com/JustEnoughLinuxOS/distribution/releases/download/${{ steps.version.outputs.version }}/JELOS-RK3326.aarch64-${{ steps.version.outputs.version }}.img.gz)|[documentation](/documentation/RK3326/)|
|**Anbernic RG353P/M/V/VS, RG503, and Powkiddy RK2023**|[JELOS-RK3566.aarch64-${{ steps.version.outputs.version }}.img.gz](https://github.com/JustEnoughLinuxOS/distribution/releases/download/${{ steps.version.outputs.version }}/JELOS-RK3566.aarch64-${{ steps.version.outputs.version }}.img.gz)|[documentation](/documentation/RK3566/)|
|**Anbernic RG552**|[JELOS-RK3399.aarch64-${{ steps.version.outputs.version }}.img.gz](https://github.com/JustEnoughLinuxOS/distribution/releases/download/${{ steps.version.outputs.version }}/JELOS-RK3399.aarch64-${{ steps.version.outputs.version }}.img.gz)|[documentation](/documentation/RK3399/)|
|**Ayaneo Handhelds, Atari VCS, and other x86_64 devices**|[JELOS-AMD64.x86_64-${{ steps.version.outputs.version }}.img.gz](https://github.com/JustEnoughLinuxOS/distribution/releases/download/${{ steps.version.outputs.version }}/JELOS-AMD64.x86_64-${{ steps.version.outputs.version }}.img.gz)|[documentation](/documentation/AMD64/)|
|**Hardkernel ODROID Go Ultra, Powkiddy RGB10 Max 3 Pro**|[JELOS-S922X.aarch64-${{ steps.version.outputs.version }}.img.gz](https://github.com/JustEnoughLinuxOS/distribution/releases/download/${{ steps.version.outputs.version }}/JELOS-S922X.aarch64-${{ steps.version.outputs.version }}.img.gz)|[documentation](/documentation/S922X/)|
|**Orange Pi 5, and Indiedroid Nova**|[JELOS-RK3588.aarch64-${{ steps.version.outputs.version }}.img.gz](https://github.com/JustEnoughLinuxOS/distribution/releases/download/${{ steps.version.outputs.version }}/JELOS-RK3588.aarch64-${{ steps.version.outputs.version }}.img.gz)|[documentation](/documentation/RK3588/)|
|**Powkiddy x55**|[JELOS-RK3566-X55.aarch64-${{ steps.version.outputs.version }}.img.gz](https://github.com/JustEnoughLinuxOS/distribution/releases/download/${{ steps.version.outputs.version }}/JELOS-RK3566-X55.aarch64-${{ steps.version.outputs.version }}.img.gz)|[documentation](/documentation/RK3566-X55/)|
## Upgrading
* Download and install the update online via the System Settings menu.
Expand All @@ -128,6 +128,7 @@ jobs:
## Documentation
* [Home](https://github.com/JustEnoughLinuxOS/distribution/wiki)
* [General Documentation](https://github.com/JustEnoughLinuxOS/distribution/documentation)
* [Donating to JELOS](https://github.com/JustEnoughLinuxOS/distribution/wiki/Donating-to-JELOS)
* [Frequently asked Questions](https://github.com/JustEnoughLinuxOS/distribution/wiki/Frequently-Asked-Questions)
* [HotKeys](https://github.com/JustEnoughLinuxOS/distribution/wiki/Hotkeys)
Expand Down
20 changes: 12 additions & 8 deletions config/functions
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1780,20 +1780,24 @@ start_system_doc() {
echo "Unable to generate documentation, define SYSDOC in options."
exit 1
fi
if [ -e "${SYSDOC}" ]
if [ ! -d "${SYSDOCROOT}" ]
then
rm -f ${SYSDOC}
mkdir ${SYSDOCROOT}
fi
if [ -e "${SYSDOC}.md" ]
then
rm -f ${SYSDOC}.md
fi
if [ -e "${ROOT}/templates/HEADER.md" ]
then
cat ${ROOT}/templates/HEADER.md >${SYSDOC}
cat ${ROOT}/templates/HEADER.md >${SYSDOC}.md
fi
DOCTEMPLATE="$(basename ${SYSDOCROOT})"
DOCTEMPLATE="$(basename ${SYSDOC})"
if [ -e "${ROOT}/templates/${DOCTEMPLATE}.md" ]
then
cat ${ROOT}/templates/${DOCTEMPLATE}.md >>${SYSDOC}
cat ${ROOT}/templates/${DOCTEMPLATE}.md >>${SYSDOC}.md
fi
cat <<EOF >>${SYSDOC}
cat <<EOF >>${SYSDOC}.md
|Manufacturer|System|Release Date|Games Path|Supported Extensions|Emulator / Core|
|----|----|----|----|----|----|
EOF
Expand Down Expand Up @@ -1826,9 +1830,9 @@ mk_system_doc() {
cat ${DOCTMP}/${system}:emulators.tmp >>${SYSDOC}.tmp
fi
echo "|" >>${SYSDOC}.tmp
cat ${SYSDOC}.tmp | sort >>${SYSDOC}
rm -f ${SYSDOC}.tmp
done
cat ${SYSDOC}.tmp | sort -f >>${SYSDOC}.md
rm -f ${SYSDOC}.tmp
}

### Generate ES Systems
Expand Down
4 changes: 2 additions & 2 deletions config/options
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ OS_VERSION=$(date +%Y%m%d)
BUILD_DATE=$(date)

# defines supported systems documentation path
SYSDOCROOT="${ROOT}/documentation/SUPPORTED_SYSTEMS"
SYSDOC="${SYSDOCROOT}-${DEVICE}.md"
SYSDOCROOT="${ROOT}/documentation/${DEVICE}/"
SYSDOC="${SYSDOCROOT}/SUPPORTED_EMULATORS_AND_CORES"

# include helper functions
. config/functions
Expand Down
Loading

0 comments on commit b6a8037

Please sign in to comment.