Skip to content

Commit 1fb1a2d

Browse files
committed
DTNN-132 Update README absolute paths
1 parent 89b43c2 commit 1fb1a2d

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,12 @@ See https://github.com/intel/tinycbor.git.
6565
```
6666
cd <chosen working directory>
6767
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
68+
git clone https://github.com/nasa/cFS "${CFS_HOME}"/cfs-bundle
69+
cd "${CFS_HOME}"/cfs-bundle
7070
git submodule init
7171
git submodule update
72-
git clone https://github.com/nasa/bp "${CFS_HOME}"/apps/bp
73-
git clone https://github.com/nasa/bplib "${CFS_HOME}"/libs/bplib
72+
git clone https://github.com/nasa/bp "${CFS_HOME}"/cfs-bundle/apps/bp
73+
git clone https://github.com/nasa/bplib "${CFS_HOME}"/cfs-bundle/libs/bplib
7474
```
7575

7676
4. Setup OSAL.
@@ -80,15 +80,15 @@ Run CMake for OSAL.
8080
Run Make for OSAL with the destination directory `./osal-staging`.
8181

8282
```
83-
cd ./cfs-bundle/osal
84-
# cmake options from .github/actions/setup-osal/action.yml
83+
cd "${CFS_HOME}"/cfs-bundle/osal
84+
# cmake options from .github/actions/setup-osal/action.yml:
8585
CMAKE_OSAL_DEFS="-DCMAKE_INSTALL_PREFIX=/usr/local -DOSAL_SYSTEM_BSPTYPE=generic-linux "
8686
# config-options:
8787
CMAKE_OSAL_DEFS+="-DCMAKE_BUILD_TYPE=Release -DOSAL_OMIT_DEPRECATED=TRUE "
8888
CMAKE_OSAL_DEFS+="-DENABLE_UNIT_TESTS=TRUE -DOSAL_CONFIG_DEBUG_PERMISSIVE_MODE=ON "
89-
cmake $CMAKE_OSAL_DEFS -B ../osal-build
90-
cd ../osal-build
91-
make DESTDIR=../osal-staging install
89+
cmake $CMAKE_OSAL_DEFS -B "${CFS_HOME}"/osal-build
90+
cd "${CFS_HOME}"/osal-build
91+
make DESTDIR="${CFS_HOME}"/osal-staging install
9292
```
9393

9494
5. Build bplib and the test runners
@@ -100,13 +100,14 @@ Setup the required environment variables for CMake, choosing between Debug or Re
100100
```
101101
# MATRIX_BUILD_TYPE=[Debug|Release]
102102
# MATRIX_OS_LAYER=[OSAL|POSIX]
103-
# BPLIB_SOURCE=$CFS_HOME/cfs_bundle/libs/bplib
104-
# BPLIB_BUILD=./bplib-build-matrix-<MATRIX_BUILD_TYPE>-<MATRIX_OS_LAYER>
103+
# BPLIB_SOURCE="${CFS_HOME}"/cfs-bundle/libs/bplib
104+
# BPLIB_BUILD="${CFS_HOME}/bplib-build-matrix-${MATRIX_BUILD_TYPE}-${MATRIX_OS_LAYER}"
105105
```
106106

107107
Run CMake and make all to build bplib and the bplib tests.
108108

109109
```
110+
export NasaOsal_DIR="${CFS_HOME}/osal-staging/usr/local/lib/cmake"
110111
cmake \
111112
-DCMAKE_BUILD_TYPE="${MATRIX_BUILD_TYPE}" \
112113
-DBPLIB_OS_LAYER="${MATRIX_OS_LAYER}" \
@@ -122,13 +123,12 @@ Run CMake and make all to build bplib and the bplib tests.
122123
6. Test bplib
123124

124125
```
125-
export NasaOsal_DIR=osal-staging/usr/local/lib/cmake
126-
cd ./bplib-build-matrix-Debug-OSAL
126+
cd "${CFS_HOME}"/bplib-build-matrix-Debug-OSAL
127127
common/ut-coverage/coverage-bplib_common-testrunner
128128
```
129129

130130
#### Build bplib Stand Alone
131-
1. Clone bplib into a working directory.
131+
1. Clone bplib into a working directory. The build uses BPLIB_HOME rather than CFS_HOME for a stand alone build.
132132

133133
```
134134
cd <chosen working directory>
@@ -141,13 +141,13 @@ Run CMake and make all to build bplib and the bplib tests.
141141

142142
Note that the possible build folders are one of <Debug,Release>-POSIX for the build type and operating system layer respectively.
143143

144-
Setup the required environment variables for CMake, choosing between Debug or Release, and POSIX.
144+
Setup the required environment variables for CMake, choosing between Debug or Release. POSIX is the only operating system layer supported by the stand alone build.
145145

146146
```
147147
# MATRIX_BUILD_TYPE=[Debug|Release]
148148
# MATRIX_OS_LAYER=POSIX
149-
# BPLIB_SOURCE=$CFS_HOME/cfs_bundle/libs/bplib
150-
# BPLIB_BUILD=./bplib-build-matrix-<MATRIX_BUILD_TYPE>-POSIX
149+
# BPLIB_SOURCE="${BPLIB_HOME}"/bplib
150+
# BPLIB_BUILD="${BPLIB_HOME}/bplib-build-matrix-${MATRIX_BUILD_TYPE}-POSIX"
151151
```
152152

153153
Run CMake and make all to build bplib and the bplib tests.

0 commit comments

Comments
 (0)