aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 18 insertions, 18 deletions
diff --git a/README.md b/README.md
index 8d814c9..c2ad2c9 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
-# 1. High Level Voice Service (VSHL)
-This repository hosts the code for the AGL's high level voice service binding also known as VSHL.
+# 1. High Level Voice Service Core (VSHL-CORE)
+This repository hosts the code for the AGL's high level voice service's core request arbitration binding also known as VSHL-CORE.
Please refer to the [architecture](https://confluence.automotivelinux.org/display/SPE/Speech+EG+Architecture) for more information.
# 2. Build Dependencies and License Information
@@ -11,14 +11,14 @@ During the build time, the following dependencies are fetched and run by the bui
```
export MY_PROJECTS_DIR = <Your Project Directory>
pushd $MY_PROJECTS_DIR
-git clone --recursive https://gerrit.automotivelinux.org/gerrit/apps/agl-service-voice-high
+git clone --recursive https://gerrit.automotivelinux.org/gerrit/apps/agl-service-voice-high-core
```
# 4. Renesas R-Car M3 board
-## 4.1 Building VSHL
+## 4.1 Building VSHL Core
```
-pushd agl-voiceservice-highlevel
+pushd agl-service-voice-high-core
mkdir build
pushd build
source /opt/agl-sdk/6.0.1-aarch64/environment-setup-aarch64-agl-linux
@@ -27,43 +27,43 @@ make autobuild
popd
./conf.d/autobuild/agl/autobuild package
```
-* The build output will be located at $MY_PROJECTS_DIR/agl-voiceservice-highlevel/build/vshl.wgt
+* The build output will be located at $MY_PROJECTS_DIR/agl-service-voice-high-core/build/vshl-core.wgt
-## 4.2 Running VSHL
+## 4.2 Running VSHL Core
```
-# afm-util install vshl.wgt
-# afm-util start vshl@1.0
+# afm-util install vshl-core.wgt
+# afm-util start vshl-core@1.0
```
# 5. Ubuntu 16.04
-## 5.1 Building VSHL
+## 5.1 Building VSHL Core
```
-pushd agl-voiceservice-highlevel/
+pushd agl-service-voice-high-core
mkdir build
pushd build
cmake ..
make autobuild
popd
./conf.d/autobuild/linux/autobuild package
-````
+```
To build the included unit tests modify the cmake step as following:
cmake .. -DENABLE_UNIT_TESTS=ON
-## 5.2 Running VSHL
+## 5.2 Running VSHL Core
```
-afb-daemon --port=1111 --name=afb-vshl --workdir=$MY_PROJECTS_DIR/agl-voice-service/build/package --ldpaths=lib --roothttp=htdocs --token= -vvv
+afb-daemon --port=1111 --name=afb-vshl-core --workdir=$MY_PROJECTS_DIR/agl-voice-service-high-core/build/package --ldpaths=lib --roothttp=htdocs --token= -vvv
```
# 6. Running the Unit Tests
## 6.1 Ubuntu 16.04
```
-pushd agl-voiceservice-highlevel/
-./build/src/plugins/vshl-api_Test
+pushd agl-service-voice-high-core/
+./build/src/plugins/vshl-core-api_Test
popd
```
-# 7. Testing VSHL
+# 7. Testing VSHL Core
* The binding can be tested by launching the HTML5 sample application that is bundled with the package in a browser.
```
@@ -82,7 +82,7 @@ clang-format -i <path to source file>
* Setup clang-format as pre-commit git hook. This is one time step after you clone the repo
```
-cd ${VSHL_ROOT}
+cd ${VSHL_CORE_ROOT}
cp tools/pre-commit .git/hooks/pre-commit
```