update installation and README#819
Conversation
There was a problem hiding this comment.
Pull request overview
Updates repository installation/build documentation by adding a Markdown README and preserving prior instructions in a separate text file.
Changes:
- Add
readme.mdwith expanded, structured installation & compilation instructions (CMake + platform-specific notes). - Add
readme.old.txtcontaining the previous plain-text instructions.
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| readme.md | Adds a Markdown-formatted installation/build guide, emphasizing CMake and platform-specific build paths. |
| readme.old.txt | Preserves the prior plain-text installation/build instructions for reference. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| make | ||
| ``` | ||
| 4. (Optional) Run tests: | ||
| ```sh | ||
| make test |
There was a problem hiding this comment.
This section claims CMake is recommended for Windows/Linux/macOS, but the build/test commands use make / make test, which won’t work with common Windows CMake generators (e.g., Visual Studio) and can differ on macOS too. Consider switching to generator-agnostic commands like cmake --build . and ctest, or explicitly documenting that Unix Makefiles (and make) are assumed.
| make | |
| ``` | |
| 4. (Optional) Run tests: | |
| ```sh | |
| make test | |
| cmake --build . |
- (Optional) Run tests:
ctest
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
update installation and README.md instead of README.txt