From eadc4827d21068647ccfbe979a17f494ac0eba86 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20Kvarnstr=C3=B6m?= <jonas.kvarnstrom@liu.se> Date: Mon, 12 Apr 2021 08:30:49 +0200 Subject: [PATCH] Fixed various typos. --- doc/docker_nvidia.md | 2 +- doc/futurereleases.md | 10 ++--- doc/minimal_dockers.md | 90 ++++++++++++++++++------------------- doc/prepare_ros_computer.md | 2 +- doc/workinprogress.md | 6 +-- docker/build.sh | 2 +- 6 files changed, 56 insertions(+), 56 deletions(-) diff --git a/doc/docker_nvidia.md b/doc/docker_nvidia.md index 8fbe75f..a277df8 100644 --- a/doc/docker_nvidia.md +++ b/doc/docker_nvidia.md @@ -1,6 +1,6 @@ # Installing Nvidia Drivers for Docker -If you are **not** using a virtual machine (you run Ubuntu LTS directly on your computer), and you have an nVidia graphics card, you can get 3D-accelerated graphics according to [these instructions](https://github.com/NVIDIA/nvidia-docker). +If you are **not** using a virtual machine (you run Ubuntu LTS directly on your computer), and you have an Nvidia graphics card, you can get 3D-accelerated graphics according to [these instructions](https://github.com/NVIDIA/nvidia-docker). Alternatively, do the following (though the web page linked above may be more up to date): diff --git a/doc/futurereleases.md b/doc/futurereleases.md index c74eeaa..7f9d2fb 100644 --- a/doc/futurereleases.md +++ b/doc/futurereleases.md @@ -2,10 +2,10 @@ BIG ISSUE: wexec STARTED IN SCREEN DO NOT DIE WHEN SCREEN KILLED WITH C-o \ y Later you will use screen. Notice that the command key for screen is -here C-o. The screen file are in: waraps/screen +here C-o. The screen files are in `waraps/screen`. -NOTICE: C-o \ do not kill the docker containers. If somebody find out -how to solve this problem pleae let us know. +NOTICE: C-o \ does not kill the docker containers. If somebody finds out +how to solve this problem please let us know. @@ -13,11 +13,11 @@ how to solve this problem pleae let us know. NOT ROBUST HANGING PROCESSES. Be aware of the possibility of hanging docker processes. -### Loading configurtion launch files +### Loading configuration launch files For each agent you have to load a configuration file and that have to be done before the screen for the agent is loaded. The arguments to -the config.launch file is location and ns. +the `config.launch` file are location and ns. Suppose we want to start unit /op0 and /dji0 in Gränsö then we do: diff --git a/doc/minimal_dockers.md b/doc/minimal_dockers.md index aa074c9..d27551a 100644 --- a/doc/minimal_dockers.md +++ b/doc/minimal_dockers.md @@ -3,7 +3,7 @@ ## Scripts You should now have help scripts in the path. For example there is a -script tst that is used among other things to start a TST factorty. For example: +script TST that is used among other things to start a TST factory. For example: ```bash tst roslaunch lrs_launch tst_part.launch ns:=${NS} ``` @@ -48,7 +48,7 @@ The simplest way is to check ouy the repo: ```bash git clone git@gitlab.liu.se:lrs/waraps.git ``` -and make sure that waraps/script is in the path +and make sure that `waraps/script` is in the path The following scripts will then be available: @@ -88,11 +88,11 @@ docker run \ ### base-dji-minimal #### Contains repos -- dji_sdk -- motion_models -- converter_mavdjisdk -- nonlinearmpc -- lrs_gazebo +- `dji_sdk` +- `motion_models` +- `converter_mavdjisdk` +- `nonlinearmpc` +- `lrs_gazebo` #### Example of usage ```bash @@ -189,9 +189,9 @@ tst roslaunch lrs_launch tst_part ns:=/dji0 #### Example of usage -Start the nodes_ -- tstexecmanager -- resourceagent +Start the nodes: +- `tstexecmanager` +- `resourceagent` ```bash exec_system roslaunch lrs_launch exec_part.launch ns:=/dji0 @@ -201,11 +201,11 @@ exec_system roslaunch lrs_launch exec_part.launch ns:=/dji0 ### exec-exec-minimal #### Contain repos -- lrs_exec_exec -- lrs_interaction_msgs -- lrs_srvs_tfpop -- lrs_util_interaction -- lrs_util_tfpop +- `lrs_exec_exec` +- `lrs_interaction_msgs` +- `lrs_srvs_tfpop` +- `lrs_util_interaction` +- `lrs_util_tfpop` #### Example of usage @@ -217,25 +217,25 @@ exec_exec roslaunch lrs_launch exec_exec.launch ns:=/dji0 #### Contain repos -- lrs_basic -- lrs_common -- lrs_exec_common -- lrs_exec_scan -- lrs_interaction_msgs -- lrs_kdb_bridge_msgs -- lrs_kdb_msgs -- lrs_launch -- lrs_msgs -- lrs_msgs_mp -- lrs_scan_msgs -- lrs_srvs_del -- lrs_srvs_mp -- lrs_util -- lrs_util_del -- lrs_util_interaction -- lrs_util_kdb -- lrs_util_mp -- lrs_util_scan +- `lrs_basic` +- `lrs_common` +- `lrs_exec_common` +- `lrs_exec_scan` +- `lrs_interaction_msgs` +- `lrs_kdb_bridge_msgs` +- `lrs_kdb_msgs` +- `lrs_launch` +- `lrs_msgs` +- `lrs_msgs_mp` +- `lrs_scan_msgs` +- `lrs_srvs_del` +- `lrs_srvs_mp` +- `lrs_util` +- `lrs_util_del` +- `lrs_util_interaction` +- `lrs_util_kdb` +- `lrs_util_mp` +- `lrs_util_scan` #### Example of usage @@ -247,16 +247,16 @@ exec_common roslaunch lrs_launch exec_common.launch ns:=/dji0 #### Contain repos -- lrs_basic -- lrs_common -- lrs_exec_dji -- lrs_interaction_msgs -- lrs_launch -- lrs_msgs -- lrs_msgs_mp -- lrs_srvs -- lrs_util_interaction -- Onboard-SDK-ROS +- `lrs_basic` +- `lrs_common` +- `lrs_exec_dji` +- `lrs_interaction_msgs` +- `lrs_launch` +- `lrs_msgs` +- `lrs_msgs_mp` +- `lrs_srvs` +- `lrs_util_interaction` +- `Onboard-SDK-ROS` #### Example of usage @@ -343,7 +343,7 @@ OLD: roscore ``` -### Loading configurtion launch files +### Loading configuration launch files For each agent you have to load a configuration file and that have to be done before the screen for the agent is loaded. The arguments to diff --git a/doc/prepare_ros_computer.md b/doc/prepare_ros_computer.md index 36b6740..c8d96a2 100644 --- a/doc/prepare_ros_computer.md +++ b/doc/prepare_ros_computer.md @@ -2,7 +2,7 @@ +++++++++++++++ Obsolete? ++++++++++++++++++++ -If you already have a ROS computer with a docker daeamon follow the +If you already have a ROS computer with a docker daemon follow the instructions below. ## Configuring Development Computer diff --git a/doc/workinprogress.md b/doc/workinprogress.md index ee3a263..0083009 100644 --- a/doc/workinprogress.md +++ b/doc/workinprogress.md @@ -1,10 +1,10 @@ INFO IN PROGRESS OF BEING MOVED TO NOTEBOOK -Things needed to build a development docker image based on waraps base LRS image. +Things needed to build a development docker image based on WARA PS base LRS image. Also instructions how to run different units from a docker. This will -replace the setup we have had with virtual machines that combitech +replace the setup we have had with virtual machines that Combitech have used. Will be used for more things in the future. @@ -49,7 +49,7 @@ roslaunch lrs_launch location_granso.launch ns:=/dji0 - dji_system - wdb -### Dji Simulator with MPC Trajectory Contoller +### Dji Simulator with MPC Trajectory Controller ```bash docker run \ diff --git a/docker/build.sh b/docker/build.sh index 424de27..bddb9db 100755 --- a/docker/build.sh +++ b/docker/build.sh @@ -1,7 +1,7 @@ #!/bin/bash # Basic script to just build the personal docker image without any bells and -# whisles +# whistles exec docker build \ --no-cache \ -- GitLab