Skip to content

Commit 89b43c2

Browse files
committedJul 29, 2024·
DTNN-132 Update README based on meeting w/Charles
1 parent ea583aa commit 89b43c2

File tree

1 file changed

+41
-41
lines changed

1 file changed

+41
-41
lines changed
 

‎README.md

+41-41
Original file line numberDiff line numberDiff line change
@@ -60,18 +60,20 @@ See https://github.com/intel/tinycbor.git.
6060
- tinycbor version 0.6.0
6161

6262
#### Build bplib with cFS
63-
3. Create a subdirectory for building bplib. Run CMake to set up the build tree. Build bplib by running __make__ in the build subdirectory:
63+
3. Clone, init, and update cFS and all required submodules. Then clone bp and bplib to the cFS local repository.
6464

65-
```sh
66-
git clone https://github.com/nasa/cFS cfs_bundle
67-
cd ./cfs_bundle
65+
```
66+
cd <chosen working directory>
67+
export CFS_HOME="$(pwd)" # Use CFS_HOME at your discretion
68+
git clone https://github.com/nasa/cFS "${CFS_HOME}"/cfs_bundle
69+
cd "${CFS_HOME}"/cfs_bundle
6870
git submodule init
6971
git submodule update
70-
git clone https://github.com/nasa/bp ./apps/bp
71-
git clone https://github.com/nasa/bplib ./libs/bplib
72+
git clone https://github.com/nasa/bp "${CFS_HOME}"/apps/bp
73+
git clone https://github.com/nasa/bplib "${CFS_HOME}"/libs/bplib
7274
```
7375

74-
3. Setup OSAL.
76+
4. Setup OSAL.
7577

7678
Define the OSAL definitions for CMake.
7779
Run CMake for OSAL.
@@ -89,22 +91,22 @@ Run Make for OSAL with the destination directory `./osal-staging`.
8991
make DESTDIR=../osal-staging install
9092
```
9193

92-
4. Build the test runners
94+
5. Build bplib and the test runners
9395

94-
Note that the possible build folders are one of <Debug/Release>-<OSAL/POSIX> for the build type and operating system layer respectively.
96+
Note that the possible build folders are one of <Debug,Release>-<OSAL,POSIX> for the build type and operating system layer respectively.
9597

96-
```sh
97-
# Create the build folder based on Debug/Release and OSAL/POSIX
98+
Setup the required environment variables for CMake, choosing between Debug or Release, and OSAL or POSIX.
99+
100+
```
98101
# MATRIX_BUILD_TYPE=[Debug|Release]
99102
# MATRIX_OS_LAYER=[OSAL|POSIX]
100-
# BPLIB_SOURCE=<path-to-cfs>/libs/bplib
103+
# BPLIB_SOURCE=$CFS_HOME/cfs_bundle/libs/bplib
101104
# BPLIB_BUILD=./bplib-build-matrix-<MATRIX_BUILD_TYPE>-<MATRIX_OS_LAYER>
102-
# one of:
103-
# BPLIB_BUILD=./bplib-build-matrix-Debug-OSAL
104-
# BPLIB_BUILD=./bplib-build-matrix-Debug-POSIX
105-
# BPLIB_BUILD=./bplib-build-matrix-Release-OSAL
106-
# BPLIB_BUILD=./bplib-build-matrix-Release-POSIX
107-
105+
```
106+
107+
Run CMake and make all to build bplib and the bplib tests.
108+
109+
```
108110
cmake \
109111
-DCMAKE_BUILD_TYPE="${MATRIX_BUILD_TYPE}" \
110112
-DBPLIB_OS_LAYER="${MATRIX_OS_LAYER}" \
@@ -116,10 +118,8 @@ Note that the possible build folders are one of <Debug/Release>-<OSAL/POSIX> for
116118
make all
117119
```
118120

119-
5. Test bplib
120-
121121
#### Example Test
122-
122+
6. Test bplib
123123

124124
```
125125
export NasaOsal_DIR=osal-staging/usr/local/lib/cmake
@@ -128,31 +128,31 @@ Note that the possible build folders are one of <Debug/Release>-<OSAL/POSIX> for
128128
```
129129

130130
#### Build bplib Stand Alone
131-
6. Create a subdirectory for building bplib.
131+
1. Clone bplib into a working directory.
132132

133-
```sh
134-
git clone https://github.com/nasa/bplib ./bplib
135133
```
134+
cd <chosen working directory>
135+
export BPLIB_HOME="$(pwd)" # Use BPLIB_HOME at your discretion
136136
137-
7. Build the test runners
137+
git clone https://github.com/nasa/bplib "${BPLIB_HOME}"/bplib
138+
```
138139

139-
Note that the possible build folders are one of <Debug/Release>-<OSAL/POSIX> for the build type and operating system layer respectively.
140+
2. Build bplib and the test runners
140141

141-
```sh
142-
# Create the build folder based on Debug/Release and OSAL/POSIX
142+
Note that the possible build folders are one of <Debug,Release>-POSIX for the build type and operating system layer respectively.
143+
144+
Setup the required environment variables for CMake, choosing between Debug or Release, and POSIX.
145+
146+
```
143147
# MATRIX_BUILD_TYPE=[Debug|Release]
144-
# MATRIX_OS_LAYER=[OSAL|POSIX]
145-
# BPLIB_SOURCE=<path-to-cfs>/libs/bplib
146-
# BPLIB_BUILD=./bplib-build-matrix-<MATRIX_BUILD_TYPE>-<MATRIX_OS_LAYER>
147-
# one of:
148-
# BPLIB_BUILD=./bplib-build-matrix-Debug-OSAL
149-
# BPLIB_BUILD=./bplib-build-matrix-Debug-POSIX
150-
# BPLIB_BUILD=./bplib-build-matrix-Release-OSAL
151-
# BPLIB_BUILD=./bplib-build-matrix-Release-POSIX
152-
153-
# Run cmake from the current directory with the CMake folder
154-
# indicated by -S "$BPLIB_SOURCE}".
148+
# MATRIX_OS_LAYER=POSIX
149+
# BPLIB_SOURCE=$CFS_HOME/cfs_bundle/libs/bplib
150+
# BPLIB_BUILD=./bplib-build-matrix-<MATRIX_BUILD_TYPE>-POSIX
151+
```
155152

153+
Run CMake and make all to build bplib and the bplib tests.
154+
155+
```
156156
cmake \
157157
-DCMAKE_BUILD_TYPE="${MATRIX_BUILD_TYPE}" \
158158
-DBPLIB_OS_LAYER="${MATRIX_OS_LAYER}" \
@@ -164,9 +164,9 @@ Note that the possible build folders are one of <Debug/Release>-<OSAL/POSIX> for
164164
make all
165165
```
166166

167-
8. Test bplib stand alone
167+
3. Test bplib stand alone
168168

169-
The example program `bpcat` is available in the bplib stand alone build
169+
The example program `bpcat` referenced below is available in the bplib stand alone build.
170170

171171
```
172172
$ ./bplib-build-matrix-Debug-POSIX/app/bpcat --help

0 commit comments

Comments
 (0)
Please sign in to comment.