Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refresh readme #415

Merged
merged 2 commits into from
Jan 8, 2024
Merged

refresh readme #415

merged 2 commits into from
Jan 8, 2024

Conversation

Ramen2X
Copy link
Member

@Ramen2X Ramen2X commented Jan 7, 2024

This PR updates the project README to be more in line with the project's current status.

I've made several changes:

  • Indicated that we are explicitly working from LEGO Island's 1.1 English release. It isn't very common knowledge, but there are multiple iterations of LEGO Island 1.1. Some localization teams opted to recompile the entire game rather than just updating the assets, producing a different, unique binary (though this isn't true for all localized versions of LEGO Island). I've also added hashes for the version of ISLE and LEGO1 that we have derived this code from to the bottom of the README, so contributors can make absolutely sure that there won't be any conflicts with what they got.
  • Reworded the static report of LEGO1's decompilation status to no longer claim that the library is "very much incomplete". I feel that this is now inaccurate; especially as we are starting to visually see some progress. The claim that it "cannot be used" also could imply that it isn't useful to anyone, including developers. Instead, I've simply made it clear that it isn't usable for gameplay.
  • Changed some technical wording structure from singular to plural. We are working on two binaries in this project rather than one, so I feel that this makes more sense.
  • Added LEGO Island's registry paths to mentions of the registry. I felt that it was odd before that there was indication that you could create a portable environment for LEGO Island by updating the registry but that there was no further elaboration on this. I've addressed this.

Additionally, I've made several grammar adjustments and fixed some typos.

Of course, I'd like to hear what everyone else thinks of these adjustments. I'm open to any suggestions or changes.

Copy link
Member

@foxtacles foxtacles left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@Ramen2X
Copy link
Member Author

Ramen2X commented Jan 8, 2024

Merging - if anyone wants to request any changes, you're welcome to open a PR.

@Ramen2X Ramen2X merged commit 6a85e62 into isledecomp:master Jan 8, 2024
10 checks passed
@Ramen2X Ramen2X deleted the readme branch January 8, 2024 00:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants