wbrawner/distribution
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update readme.

Browse source
This commit is contained in:
fewtarius 2023-08-14 11:40:19 +00:00
parent 415f7b3379
commit 15b58f5292
No known key found for this signature in database
GPG key ID: F4AE55305D1B8C1A
1 changed files with 44 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

72
README.md
View file

@ -2,11 +2,55 @@
#
Just Enough Linux Operating System (JELOS) is an immutable Linux distribution for handheld gaming devices developed by a small community of enthusiasts. Our goal is to produce an operating system that has the features and capabilities that we need, and to have fun as we develop it.
## Features
* JELOS has a very active community of developers and users.
* Integrated cross-device local and remote network play.
* In-game touch support on supported devices.
* Fine grain control for battery life or performance.
* Includes support for playing Music and Video.
* Bluetooth audio and controller support.
* Supports HDMI audio and video out.
* Device to device and device to cloud sync with Syncthing and rclone.
* VPN support with Wireguard, Tailscale, and ZeroTier.
* Includes built-in support for scraping and retroachievements.
## Screenshots
|System View|Menu View|Game List|
|----|----|----|
|![system-view](https://github.com/JustEnoughLinuxOS/distribution/assets/88717793/3f8b0b5a-c3ba-4b56-a0fb-d72cf143e44f)|![menu](https://github.com/JustEnoughLinuxOS/distribution/assets/88717793/2a6f0d0a-9b13-4619-ab08-19791d49d3d0)|![gamelist-view-metadata-off-immersive](https://github.com/JustEnoughLinuxOS/distribution/assets/88717793/9120a7c4-f06d-4236-a3e8-d49c7089f727)|
## Community
The JELOS community utilizes Discord for discussion, if you would like to join us please use the link below.
* [https://discord.gg/seTxckZjJy](https://discord.gg/seTxckZjJy)
## Documentation
### Documentation For Developers
* [Adding Hardware Quirks](/documentation/DEVEL_ADD_HARDWARE_QUIRKS.md)
* [Building The Distribution](/documentation/DEVEL_BUILDING_JELOS.md)
* [Contributor Code of Conduct](/CODE_OF_CONDUCT.md)
* [Contributing to JELOS](/CONTRIBUTING.md)
* [Creating Packages](/documentation/DEVEL_CREATING_PACKAGES.md)
* [Pull Request Template](/PULL_REQUEST_TEMPLATE.md)
### Documentation For Everyone
* [Installation and Device Support](https://github.com/JustEnoughLinuxOS/distribution/tree/main#installation)
* [Device Specific Documentation](/documentation/PER_DEVICE_DOCUMENTATION)
* [Donating to JELOS](/documentation/GENERAL_DONATING_TO_JELOS.md)
* [Frequently Asked Questions](/documentation/GENERAL_FREQUENTLY_ASKED_QUESTIONS.md)
* [Hotkeys and Button Codes](/documentation/GENERAL_HOTKEYS_AND_BUTTON_CODES.md)
* [Optimizing Performance and Battery Life](/documentation/GENERAL_PERFORMANCE_AND_BATTERY.md)
### Using JELOS
* [Setting Up Cloud Drives](/documentation/SETUP_CLOUD_DRIVES.md)
* [Setting Up Syncthing](/documentation/SETUP_SYNCTHING.md)
* [Game Engines and Launch Files](/documentation/SETUP_GAME_ENGINES_AND_LAUNCH_FILES.md)
* [Configuring Moonlight Streaming](/documentation/SETUP_MOONLIGHT_STREAMING.md)
* [Setting Up P2P Networking With ZeroTier](/documentation/SETUP_P2P_ZEROTIER.md)
* [Configure TailScale VPN](/documentation/SETUP_VPN_TAILSCALE.md)
* [Setting Up Wireguard VPN](/documentation/SETUP_VPN_WIREGUARD.md)
* [Creating Custom Shader Presets for Per Game / Per System Use](https://github.com/JustEnoughLinuxOS/distribution/blob/main/documentation/GENERAL_CUSTOM_SHADERS.md)
## Device Support
JELOS supports a variety of ARM and Intel/AMD based devices<sup>1</sup>.
| Manufacturer | Device | CPU / Architecture | Kernel | GL driver | Interface |
@ -91,34 +135,6 @@ limitations under the License.
## Network Access
* External services are disabled by default in stable builds. When enabled, the username for ssh and samba access is "root". The root password is generated during every boot, it can be found in the System Settings menu.
## Documentation
### Documentation For Developers
* [Adding Hardware Quirks](/documentation/DEVEL_ADD_HARDWARE_QUIRKS.md)
* [Building The Distribution](/documentation/DEVEL_BUILDING_JELOS.md)
* [Contributor Code of Conduct](/CODE_OF_CONDUCT.md)
* [Contributing to JELOS](/CONTRIBUTING.md)
* [Creating Packages](/documentation/DEVEL_CREATING_PACKAGES.md)
* [Pull Request Template](/PULL_REQUEST_TEMPLATE.md)
### Documentation For Everyone
* [Installation and Device Support](https://github.com/JustEnoughLinuxOS/distribution/tree/main#installation)
* [Device Specific Documentation](/documentation/PER_DEVICE_DOCUMENTATION)
* [Donating to JELOS](/documentation/GENERAL_DONATING_TO_JELOS.md)
* [Frequently Asked Questions](/documentation/GENERAL_FREQUENTLY_ASKED_QUESTIONS.md)
* [Hotkeys and Button Codes](/documentation/GENERAL_HOTKEYS_AND_BUTTON_CODES.md)
* [Optimizing Performance and Battery Life](/documentation/GENERAL_PERFORMANCE_AND_BATTERY.md)
### Using JELOS
* [Setting Up Cloud Drives](/documentation/SETUP_CLOUD_DRIVES.md)
* [Setting Up Syncthing](/documentation/SETUP_SYNCTHING.md)
* [Game Engines and Launch Files](/documentation/SETUP_GAME_ENGINES_AND_LAUNCH_FILES.md)
* [Configuring Moonlight Streaming](/documentation/SETUP_MOONLIGHT_STREAMING.md)
* [Setting Up P2P Networking With ZeroTier](/documentation/SETUP_P2P_ZEROTIER.md)
* [Configure TailScale VPN](/documentation/SETUP_VPN_TAILSCALE.md)
* [Setting Up Wireguard VPN](/documentation/SETUP_VPN_WIREGUARD.md)
* [Creating Custom Shader Presets for Per Game / Per System Use](https://github.com/JustEnoughLinuxOS/distribution/blob/main/documentation/GENERAL_CUSTOM_SHADERS.md)
## Credits
Like any Linux distribution, this project is not the work of one person. It is the work of many persons all over the world who have developed the open source bits without which this project could not exist. Special thanks to CoreELEC, LibreELEC, and to developers and contributors across the open source community.