From b061725753370fa2e5c2d35d0212d0a846036775 Mon Sep 17 00:00:00 2001 From: Christian Semmler Date: Sat, 14 Jun 2025 20:49:26 -0700 Subject: [PATCH] `README.md` updates --- README.md | 20 +++++++------------- 1 file changed, 7 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index fa1a8f4a..a0f8ee7f 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [Development Vlog](https://www.youtube.com/playlist?list=PLbpl-gZkNl2Db4xcAsT_xOfOwRk-2DPHL) | [Contributing](/CONTRIBUTING.md) | [Matrix](https://matrix.to/#/#isledecomp:matrix.org) | [Forums](https://forum.mattkc.com/viewforum.php?f=1) | [Patreon](https://www.patreon.com/mattkc) -This initiative is a **work-in-progress** portable version of LEGO Island (Version 1.1, English) based on the [decompilation project](https://github.com/isledecomp/isle). Our primary goal is to transform the codebase to achieve platform independence, thereby enhancing compatibility across various systems while preserving the original game's experience as faithfully as possible. +This initiative is a portable version of LEGO Island (Version 1.1, English) based on the [decompilation project](https://github.com/isledecomp/isle). Our primary goal is to transform the codebase to achieve platform independence, thereby enhancing compatibility across various systems while preserving the original game's experience as faithfully as possible. Please note: this project is dedicated to achieving platform independence without altering the core gameplay, adding new features, enhancing visual quality, or rewriting code for improvement's sake. While those are worthwhile objectives, they are not within the scope of this project. @@ -10,12 +10,12 @@ Please note: this project is dedicated to achieving platform independence withou ### Supported platforms -| Platform | Status | -| - | - | -| Windows | [![CI](https://github.com/isledecomp/isle-portable/actions/workflows/ci.yml/badge.svg)](https://github.com/isledecomp/isle-portable/actions/workflows/ci.yml) | -| Linux | [![CI](https://github.com/isledecomp/isle-portable/actions/workflows/ci.yml/badge.svg)](https://github.com/isledecomp/isle-portable/actions/workflows/ci.yml) | -| macOS | [![CI](https://github.com/isledecomp/isle-portable/actions/workflows/ci.yml/badge.svg)](https://github.com/isledecomp/isle-portable/actions/workflows/ci.yml) | -| [Web](https://isle.pizza) | [![CI](https://github.com/isledecomp/isle-portable/actions/workflows/ci.yml/badge.svg)](https://github.com/isledecomp/isle-portable/actions/workflows/ci.yml) | +| Platform | Status | Latest release | +| - | - | - | +| Windows | [![CI](https://github.com/isledecomp/isle-portable/actions/workflows/ci.yml/badge.svg)](https://github.com/isledecomp/isle-portable/actions/workflows/ci.yml) | [Download here](https://github.com/isledecomp/isle-portable/releases/tag/continuous-Windows) | +| Linux | [![CI](https://github.com/isledecomp/isle-portable/actions/workflows/ci.yml/badge.svg)](https://github.com/isledecomp/isle-portable/actions/workflows/ci.yml) | [Download here](https://github.com/isledecomp/isle-portable/releases/tag/continuous-Linux) | +| macOS | [![CI](https://github.com/isledecomp/isle-portable/actions/workflows/ci.yml/badge.svg)](https://github.com/isledecomp/isle-portable/actions/workflows/ci.yml) | [Download here](https://github.com/isledecomp/isle-portable/releases/tag/continuous-macOS) | +| [Web](https://isle.pizza) | [![CI](https://github.com/isledecomp/isle-portable/actions/workflows/ci.yml/badge.svg)](https://github.com/isledecomp/isle-portable/actions/workflows/ci.yml) | [Download here](https://github.com/isledecomp/isle-portable/releases/tag/continuous-Emscripten) | ### Library substitutions @@ -40,12 +40,6 @@ To achieve our goal of platform independence, we need to replace any Windows-onl This project uses the [CMake](https://cmake.org/) build system, which allows for a high degree of versatility regarding compilers and development environments. Please refer to the [GitHub action](/.github/workflows//build.yml) for guidance. -## Usage - -As it stands, this project is currently not ready to be played by end users. The nature of the porting process can leave the game unstable or even completely unplayable at times while the migration of game and engine code to modern APIs continues. For this reason, there is currently no support for running any executables produced by this project outside of a development environment, and no guarantees of playability or stability are provided. - -If you are a developer who feels like you can assist with porting efforts; especially if you have experience working with standard 3D libraries, please check Contributing and get in contact with our team on Matrix for help with setup. - ## Contributing If you're interested in helping or contributing to this project, check out the [CONTRIBUTING](/CONTRIBUTING.md) page.