(docs)README.md: Update debug builds line #1277
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Ramen2X
reviewed
Dec 25, 2024
README.md
Outdated
| @@ -38,7 +38,7 @@ cmake <path-to-source> -G "NMake Makefiles" -DCMAKE_BUILD_TYPE=RelWithDebInfo | |||
| ``` | |||
| - **Visual C++ 4.2 has issues with paths containing spaces**. If you get configure or build errors, make sure neither CMake, the repository, nor Visual C++ 4.2 is in a path that contains spaces. | |||
| - Replace `<path-to-source>` with the source repository. This can be `..` if your build folder is inside the source repository. | |||
| - `RelWithDebInfo` is recommended because it will produce debug symbols useful for further decompilation work. However, you can change this to `Release` if you don't need them. `Debug` builds are not recommended because they are unlikely to be compatible with the retail `LEGO1.DLL`, which is currently the only way to use this decompilation for gameplay. | |||
| - `RelWithDebInfo` is recommended because it will produce debug symbols useful for further decompilation work. However, you can change this to `Release` if you don't need them. `Debug` builds may now work with the decompiled version of `LEGO1.DLL`, However they might still have some bugs or issues. | |||
There was a problem hiding this comment.
I would rewrite this to say that, while Debug builds can be compiled and used, they are not recommended if a developer's primary intention is matching code to the original binary, as the retail binaries were naturally compiled as Release builds.
|
Is this any better now? again sorry this is my first time doing a pr here 😅. Ah i better close and recreate this PR there is a merge branch due of sync fork |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
First time opening a pull request here. Since the LEGO1.DLL has been fully decompiled, I’ve updated the README.md to reflect that debug builds may now work with the decompiled LEGO1.DLL, as the previous line was written when the LEGO1.DLL was still a work in progress.