-
Notifications
You must be signed in to change notification settings - Fork 15
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DTNN-132 Clean up bplib prototype readme #260
DTNN-132 Clean up bplib prototype readme #260
Conversation
/doc/example-scripts/stand-alone/README.md: "Copy the example scripts to $BPLIB_HOME." |
/doc/example-scripts/stand-alone/README.md: "Verify that BPLIB_SOURCE in bplib-env-vars is the path to a clone of the bplib repository." |
/doc/example-scripts/README.md: "Verify that environment variables in $CFS_HOME/cfs-env-vars are set to the correct paths." |
The /doc/example-scripts/bplib-unit-test-functional sometimes encounters a CMake error:
|
Commit 49f6450 fixes: Comment: #260 (comment)
Resolution The error happened when bplib-unit-test-functional ran on a system that did not have OSAL installed. This was a good catch, because I didn't catch it in development. Tests Performed
|
3d3ae3c
to
0674914
Compare
Commit (0674914) fixes: Comments: Resolution |
@@ -39,99 +39,120 @@ library. | |||
|
|||
#### Prerequisites | |||
|
|||
1. The build requires the __cmake__ build system and a compiler toolchain (by default __gcc__). | |||
1. The build requires Ubuntu 22.04.4 LTS, the __cmake__ build system and a compiler toolchain (by default __gcc__). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Recommend something along the lines of "BPLib has been tested on Ubuntu 22.04.4 LTS, although it is expected to work on other POSIX-compliant operating systems."
Updated, reviewed, tested, and ready to go. |
Describe the contribution
Updates the main README with descriptive text and example configure/build/test scripts.
Testing performed
Tested all steps described in:
Expected behavior changes
The README update will benefit users with tested, reusable configure/build/test scripts.
System(s) tested on
Contributor Info - All information REQUIRED for consideration of pull request
Grafton Kennedy, Vantage Systems, Inc. (grafton.s.kennedy@nasa.gov)