Update README to document vcpkg manifest-based dependency workflow#5
Update README to document vcpkg manifest-based dependency workflow#5huytran088 wants to merge 2 commits into
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 6d8cd51176
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| - **OpenAL Soft 1.21+**: 3D audio engine | ||
| - **Assimp 5.0+**: 3D model loading (.obj, .3ds, .fbx formats) | ||
|
|
||
| > Note: The project depends on OpenAL Soft directly. ALUT is **not** required by the current manifest. |
There was a problem hiding this comment.
Restore ALUT as required dependency in README
The new dependency note says ALUT is not required, but the code still depends on ALUT APIs (<AL/alut.h>, alutInit, alutCreateBufferFromFile, alutExit) in the audio path (see GameEngine/SoundEngine.h, GameEngine/SoundEngine.cpp, and GameEngine/SoundSourceComponent.cpp). In environments that follow this README and install only the manifest-listed packages, this can produce missing-header or unresolved-symbol failures during build, so the dependency guidance is currently inaccurate until ALUT usage is removed or added to dependencies.
Useful? React with 👍 / 👎.
Motivation
vcpkg.jsonand the manifest baseline (builtin-baseline).Description
README.mdExternal Dependencies list to match the manifest entries and show minimum versions (GLFW 3.3+,GLEW 2.1+,GLM 0.9.9+,OpenAL Soft 1.21+,Assimp 5.0+) and added a note thatALUTis not required.vcpkg install).vcpkg install --triplet x64-windowsfrom the repo root and keptvcpkg integrate installfor IDE integration.Testing
git diff) and committing the updatedREADME.md.Codex Task