docs: correct build/run instructions to match the CMake build - #19
Merged
Conversation
The per-backend build docs referenced mpi/Makefile and cuda/Makefile, which do not exist — the real build path is the top-level CMake with -DAMR_BUILD_MPI=ON / -DAMR_BUILD_CUDA=ON. Fix the README backend table + MPI/ CUDA sections and the getting-started run paths (binaries are flat: build/amr, build/amr_mpi, build/amr_cuda). Correct the one-arg refine() signature in the oracle how-to, repair the docs/design/ links and drop machine-local paths in REFERENCES.md, refresh the stale Makefile header (CI is live) and the MPI/sanitizer default-ON comment. Add a License line. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What
Documentation-correctness sweep from the repo audit. No code/behavior change.
mpi/Makefile/cuda/Makefile; replaced with the real CMake path (-DAMR_BUILD_MPI=ON/-DAMR_BUILD_CUDA=ON) and flat binary names (build/amr_mpi,build/amr_cuda). Added a License line../build/omp|mpi|cuda/amr→ the actual./build/amr,./build/amr_mpi,./build/amr_cuda.refine()takes one arg (omp/tree.hpp:234), not(oracle, max_level); added the refine-to-convergence loop note.docs/design/gpu-balance-notes.mdlinks; removed machine-local~/Documents/...paths (kept DOI/arXiv).docs/CI_FUTURE.mdreference (CI is live) and corrected the MPI/sanitizer default-ON comment.Why
A fresh contributor following the README/getting-started would hit commands that fail (missing Makefiles, wrong binary paths) or an oracle example that won't compile.
🤖 Generated with Claude Code