-
Notifications
You must be signed in to change notification settings - Fork 62
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
Reverting README.md to clarify optional steps #401
base: development
Are you sure you want to change the base?
Conversation
Reverting the README back to its original state. In Step 2, the steps are optional. If you register (option 1), you can then proceed to step 3. OR you can choose to use the Project Manager option, which will register the engine and gems and create the build, allowing you to skip step 3. Signed-off-by: mcphedar <[email protected]>
The enhancement doc on this is in progress here: #399 |
@@ -142,7 +142,7 @@ If you have problems with working with LFS, see the troubleshooting guide: https | |||
|
|||
## Step 2. Register the engine, the project, and the Gems | |||
|
|||
### Required step to compile | |||
### Option #1 - Use the CLI |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
### Option #1 - Use the CLI | |
### Use the CLI to register engine and gems |
@@ -166,7 +166,7 @@ If you have problems with working with LFS, see the troubleshooting guide: https | |||
|
|||
The final step prints warnings that the compatibility check for MultiplayerSample and Blast will be skipped. These warnings can be ignored. | |||
|
|||
### Build Using the Project Manager | |||
### Option #2 - Use Project Manager |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
### Option #2 - Use Project Manager | |
### (Optional) - Configure via Project Manager |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is still incorrect. I spent 30 minutes with Games from scratch solving this and he literally used 30 seconds in his video to clarify that to people that they must register the gems because it did not work with the manager and fails when you skip that step thinking it's optional.
It's very possible those gem registration issues - especially the PopcornFX ones will be resolved in dev with this PR o3de/o3de#15933 unfortunately, that won't help anyone using the 2305 installer |
It would be better to adjust the document than to revert it back into an incorrect state where people will become frustrated and lose faith in the project. |
Reverting the README back to its original state. In Step 2, the steps are optional. If you register (option 1), you can then proceed to step 3. OR you can choose to use the Project Manager option, which will register the engine and gems and create the build, allowing you to skip step 3.