Skip to content

Update README to document vcpkg manifest-based dependency workflow#5

Open
huytran088 wants to merge 2 commits into
masterfrom
codex/revise-readme.md-dependency-sections
Open

Update README to document vcpkg manifest-based dependency workflow#5
huytran088 wants to merge 2 commits into
masterfrom
codex/revise-readme.md-dependency-sections

Conversation

@huytran088
Copy link
Copy Markdown
Owner

Motivation

  • Move README dependency instructions from ad-hoc per-package commands to the manifest-based vcpkg workflow used by CI.
  • Make it clear how minimum versions and exact resolved versions are controlled by vcpkg.json and the manifest baseline (builtin-baseline).
  • Update OpenAL/OpenGL dependency wording to reflect current manifest entries and whether ALUT is required.
  • Remove guidance that suggests manual include-path edits when vcpkg manifest integration already provides those paths.

Description

  • Updated README.md External 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 that ALUT is not required.
  • Rewrote the Dependencies Management section to describe vcpkg manifest mode and that dependencies are installed from repository root with a single manifest command (vcpkg install).
  • Replaced per-package install examples with a manifest workflow example that runs vcpkg install --triplet x64-windows from the repo root and kept vcpkg integrate install for IDE integration.
  • Reworded the OpenAL configuration note to state that include/library paths are provided automatically when vcpkg integration is enabled, removing the suggestion to perform ad-hoc include-path edits.

Testing

  • Documentation-only changes; no code or build changes were introduced so no automated build/test runs were required.
  • Verified the change locally by inspecting diffs (git diff) and committing the updated README.md.

Codex Task

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 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".

Comment thread README.md
- **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.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge 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 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant