update doc

README.md

@@ -61,7 +61,7 @@ Flexiv TDK (Teleoperation Development Kit) is an SDK provides C++ APIs for devel
 
 2. Set all the robots to `Auto/Remote Mode` via Flexiv Elements, then to run the compiled example program:
 
-       ./<program_name> [local_robot_serial_number] [remote_robot_serial_number] [path_to_omni_licenseCfg.json]
+       ./<program_name> [local_robot_serial_number] [remote_robot_serial_number] [path_to_licenseCfg.json]
 
 
 ## API Documentation

example/basics1_cartesian_teleop.cpp

@@ -166,7 +166,7 @@ int main(int argc, char* argv[])
     // Serial number of the remote robot to connect to. Remove any space, for example:
     // Rizon4s-Rizon4s-062002
     std::string remote_sn = argv[2];
-    // Path to license config json file. for example: ~/my_license/omni_licenseCfg.json
+    // Path to license config json file. for example: ~/my_license/xxx_licenseCfg.json
     std::string path_to_lic_jsn = argv[3];
 
     // Parse parameters

include/flexiv/tdk/robot_robot_teleop.hpp

@@ -30,8 +30,8 @@ class Robot2RobotTeleop
      * established.
      * @param[in] local_sn Serial number of the local robot, e.g. Rizon4s-062001.
      * @param[in] remote_sn Serial number of the remote robot, e.g. Rizon4s-062002.
-     * @param [in] path_to_license_jsn Path to the omni license config json file. See README.md to
-     * apply for license.
+     * @param [in] path_to_license_jsn Path to the license config json file. See README.md to apply
+     * for license.
      * @throw std::runtime_error if the initialization sequence failed.
      * @throw std::logic_error if the connected robot does not have a valid license; or this teleop
      * library version is incompatible with the connected robot; or model of the connected robot is

license_generator/apply_for_license.md

@@ -15,5 +15,5 @@
 
 > [!NOTE]
 > The feature id is a unique identifier and is bound to your computer hardware. You CANNOT use your license and run flexiv_tdk on other devices. Please generate feature_id and use license on the same computer.
-3. After received the license package, extract the zip package and put the .lic, .signature and .json file to a safe directory. For example, a new folder named ``omni_license`` under your home directory.
-4. Parse the path of omni_licenseCfg.json file when construct tdk class in your code.
+3. After received the license package, extract the zip package and put the .lic, .signature and .json file to a safe directory. For example, a new folder named ``tdk_license`` under your home directory.
+4. Parse the path of xxx_licenseCfg.json file when construct TDK class in your code.

thirdparty/build_and_install_dependencies.sh

@@ -1,5 +1,5 @@
 #!/bin/sh
-# This script builds from source and installs all dependencies of flexiv_omni_teleop.
+# This script builds from source and installs all dependencies of flexiv_tdk.
 
 # Absolute path of this script
 SCRIPTPATH="$(dirname $(readlink -f $0))"
@@ -9,13 +9,13 @@ set -e
 if [ "$#" -lt 1 ]; then
     echo "Error: invalid script argument"
     echo "Required argument: [install_directory_path]"
-    echo "    install_directory_path: directory to install all dependencies, should be the same as the install directory of flexiv_omni_teleop"
+    echo "    install_directory_path: directory to install all dependencies, should be the same as the install directory of flexiv_tdk"
     echo "Optional argument: [num_parallel_jobs]"
     echo "    num_parallel_jobs: number of parallel jobs used to build, if not specified, the number of CPU cores will be used"
     exit
 fi
 
-# Get dependencies install directory from script argument, should be the same as the install directory of flexiv_omni_teleop
+# Get dependencies install directory from script argument, should be the same as the install directory of flexiv_tdk
 INSTALL_DIR=$1
 echo "Dependencies will be installed to: $INSTALL_DIR"