Skip to content

Conversation

@dseyler
Copy link
Contributor

@dseyler dseyler commented Nov 4, 2024

Current situation

The current README.md says to name the build folder fsiplus-build/. This is inconsistent with later documentation, and with .gitignore, which only ignores build/

Release Notes

  • Rename fsiplus-build/ to build/ in README.md

Code of Conduct & Contributing Guidelines

@ktbolt
Copy link
Collaborator

ktbolt commented Nov 4, 2024

I am seeing a Markdown error

Building the svFSIplus Program from Source
The svFSIplus program can be compiled and linked from the GitHub source using a CMake build process. The build process creates a binary executable file named **svfsiplus**.

It would also be good to describe how to modify your path to find the svfsiplus executable.

On a separate note: Docker is not The preferred way to use svFSIplus on a laptop or workstation where you would install svfsiplus from an installer downloaded from SimTK.

Addressed markdown error
Updated path to Build Status test.yml
fixed capitalization error in test_macos.yml
@aabrown100-git aabrown100-git changed the title Update README.md build folder name Update README.md typos Nov 15, 2024
@dseyler dseyler closed this Nov 15, 2024
@dseyler dseyler deleted the patch-1 branch November 15, 2024 22:13
@dseyler dseyler mentioned this pull request Nov 15, 2024
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants