From 95c30af3949fab48330e88c97ee5e18cbc0b4b0d Mon Sep 17 00:00:00 2001 From: cosperypf Date: Sat, 25 Jun 2022 14:28:10 +0800 Subject: [PATCH] Update docker_install.md "cd $WORKSPACE" should be "cd $WORKSPACE/aimet", otherwise the CMakelist file will not be found in the next "cmake .." step --- packaging/docker_install.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/packaging/docker_install.md b/packaging/docker_install.md index de4bd8669aa..4a4e141ce97 100644 --- a/packaging/docker_install.md +++ b/packaging/docker_install.md @@ -65,7 +65,7 @@ Follow these instructions to build the AIMET code: > NOTE: **If you are inside the docker, set `WORKSPACE=""` again.** ```bash -cd $WORKSPACE +cd $WORKSPACE/aimet mkdir build && cd build # Run cmake (be sure to set the flags in the below command depending on your variant) @@ -79,28 +79,28 @@ make -j8 After a successful build, install the package using the following instructions: ```bash -cd $WORKSPACE/build +cd $WORKSPACE/aimet/build make install ``` -Once the installation step is complete, the AIMET package is created at `$WORKSPACE/build/staging/universal/lib/`. +Once the installation step is complete, the AIMET package is created at `$WORKSPACE/aimet/build/staging/universal/lib/`. ## Setup paths Setup the package and library paths as follows: ```bash -export PYTHONPATH=$WORKSPACE/build/staging/universal/lib/python:$PYTHONPATH -export LD_LIBRARY_PATH=$WORKSPACE/build/staging/universal/lib/python:$LD_LIBRARY_PATH +export PYTHONPATH=$WORKSPACE/aimet/build/staging/universal/lib/python:$PYTHONPATH +export LD_LIBRARY_PATH=$WORKSPACE/aimet/build/staging/universal/lib/python:$LD_LIBRARY_PATH ``` At this point, we are all set to use AIMET! ## Usage examples and documentation -The following steps would generate AIMET documentation including the user guide, examples and API documentation at `$WORKSPACE/build/staging/universal/Docs`: +The following steps would generate AIMET documentation including the user guide, examples and API documentation at `$WORKSPACE/aimet/build/staging/universal/Docs`: ```bash -cd $WORKSPACE/build +cd $WORKSPACE/aimet/build make doc ``` -To begin navigating the documentation, open the page `$WORKSPACE/build/staging/universal/Docs/user_guide/index.html` on any browser. +To begin navigating the documentation, open the page `$WORKSPACE/aimet/build/staging/universal/Docs/user_guide/index.html` on any browser. ## Docker information Code may *optionally* be developed inside a development docker container. This section describes how to build a docker image and launch a container using the provided [Dockerfiles](../Jenkins).