From 2d50aeda5f04569578e6226416feb0fc4c0e23b6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Davi=20Ant=C3=B4nio=20da=20Silva=20Santos?= Date: Sun, 5 Nov 2023 15:58:16 -0300 Subject: [PATCH 01/16] docs: Documenta como adicionar arquivos na VM NAOv4 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Adicionou-se a documentação de como se usa o guestfish para adicionar manualmente arquivos à VM do NAOv4. --- scripts/vms/ubuntu-14/README.md | 59 +++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) diff --git a/scripts/vms/ubuntu-14/README.md b/scripts/vms/ubuntu-14/README.md index b09f6b1..39b4445 100644 --- a/scripts/vms/ubuntu-14/README.md +++ b/scripts/vms/ubuntu-14/README.md @@ -339,3 +339,62 @@ reconfiguration event. You should be able to reset nftables to its standard configuration using the command: `nft flush ruleset`. This will break the network for the containers until the machine or the Docker service unit are restarted. + +## How to manually add files to the Virtual Machine + +You may want to add files from the host system, your current machine, to the +guest one, stored in the virtual machines. An usual way to do it is through SSH, +but it requires configuring an SSH server in the guest and a client in the host. + +A quicker way is to add the files directly to the virtual machine images. This +approach requires that the VMs must not be in execution, unlike the SSH-based +one. It is most convenient to use `guestfish`, a system shell that specialises +in manipulating virtual machine images, to manually add files to the VMs. + +You may create a script based on `inject-home.sh`, or use `guestfish` on its +interactive mode, which works similarly to the usual system shell. Even though +it requires more typing, the latter approach is more user-friendly and will be +explored in this tutorial. + +Firstly, you must know the path to the files that you wish to add to your VM and +their desired location in the virtual machine. These will be parameters that +will be used in `guestfish`'s `copy-in` command, responsible for copying files +*into* the VM. + +Then you must mount the virtual machine's partition that holds the output path. +This is the more cumbersome stage, as it requires knowing which partitions are +included in the virtual machine's image file. If you followed the previous +instructions and installed the VM using the recommended settings, you will be +able to use the following commands after executing `guestfish` on your terminal +with the working directory pointing where the image is located: + +``` + /dev/null; echo "add '${DISK_LOCATION}'" +run +mount '/dev/sda1' '/' +``` + +With the main partition mounted, you may use the `ls` command to list files and +directories. Copying files into the VM is done though the `copy-in` command: + +``` +# copying a file or directory from the current host directory +copy-in my-file-or-directory /home/softex +# copying a file or directory from an absolute path in the host +copy-in /absolute/path/in/the/host/something /desired/path/in/the/vm +``` + +The scripts use a more complicated syntax to automatically obtain the user that +has been configured in the `env-vars.sh` file: + +``` + /dev/null; echo "copy-in 'my-file' '/home/${VM_USER}/abc'" +``` + +After copying all the desired files, do not forget to unmount all the partitions +and close `guestfish` before running the VM: + +``` +umount-all +exit +``` \ No newline at end of file From d911fd092f1805d5a00bb32beec14fd0b609bc25 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Davi=20Ant=C3=B4nio=20da=20Silva=20Santos?= Date: Sun, 5 Nov 2023 16:14:39 -0300 Subject: [PATCH 02/16] docs: Adiciona aviso sobre particionamento da VM do NAOv4 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Especifica que os scripts esperam que todos os diretórios estejam na mesma partição que o raiz, `/`. --- scripts/vms/ubuntu-14/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/scripts/vms/ubuntu-14/README.md b/scripts/vms/ubuntu-14/README.md index 39b4445..2e577b3 100644 --- a/scripts/vms/ubuntu-14/README.md +++ b/scripts/vms/ubuntu-14/README.md @@ -78,6 +78,12 @@ Ubuntu 14.04 LTS installation: - Timezone: Sao Paulo - User: softex +### WARNING + +The scripts expect an *unified root* partition scheme. Do not split `/home` or +other partitions unless you know how to modify the scripts that copy data into +or from the virtual machine or guest system. + ``` ./first-boot.sh ``` From 5e9b0ece09b593259a986dd57bc28bd4c221629a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Davi=20Ant=C3=B4nio=20da=20Silva=20Santos?= Date: Sun, 5 Nov 2023 16:19:39 -0300 Subject: [PATCH 03/16] =?UTF-8?q?docs:=20clarifica=20configura=C3=A7=C3=B5?= =?UTF-8?q?es=20esperadas=20do=20Ubuntu=2014?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- scripts/vms/ubuntu-14/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/scripts/vms/ubuntu-14/README.md b/scripts/vms/ubuntu-14/README.md index 2e577b3..37bab9f 100644 --- a/scripts/vms/ubuntu-14/README.md +++ b/scripts/vms/ubuntu-14/README.md @@ -73,10 +73,10 @@ The initial images are created by the `reset-*` scripts With the drives created, run the initialisation script and install a regular Ubuntu 14.04 LTS installation: -- Language and keyboard layout: Português Brasileiro +- Language and keyboard layout: Português Brasileiro (or other UTF-8 locale) - Erase disk and install Ubuntu -- Timezone: Sao Paulo -- User: softex +- Timezone: Sao Paulo (or your local timezone) +- User: softex (must be the one specified in `VM_USER` in `env-vars.sh`) ### WARNING From 27110190ec52299ed7d6f3607b46823c25776f51 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Davi=20Ant=C3=B4nio=20da=20Silva=20Santos?= Date: Sun, 5 Nov 2023 16:22:33 -0300 Subject: [PATCH 04/16] =?UTF-8?q?docs:=20corrige=20reda=C3=A7=C3=A3o=20con?= =?UTF-8?q?fusa=20do=20aviso=20de=20parti=C3=A7=C3=B5es=20NAOv4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- scripts/vms/ubuntu-14/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scripts/vms/ubuntu-14/README.md b/scripts/vms/ubuntu-14/README.md index 37bab9f..a368401 100644 --- a/scripts/vms/ubuntu-14/README.md +++ b/scripts/vms/ubuntu-14/README.md @@ -81,8 +81,8 @@ Ubuntu 14.04 LTS installation: ### WARNING The scripts expect an *unified root* partition scheme. Do not split `/home` or -other partitions unless you know how to modify the scripts that copy data into -or from the virtual machine or guest system. +other directories into other partitions unless you know how to modify the +scripts that copy data into or from the virtual machine or guest system. ``` ./first-boot.sh From 6042995da86ab1262e43aadc8fc05ecd04248fbb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Davi=20Ant=C3=B4nio=20da=20Silva=20Santos?= Date: Sun, 5 Nov 2023 16:31:11 -0300 Subject: [PATCH 05/16] docs: explicar como funcionam scripts iniciais NAOv4 --- scripts/vms/ubuntu-14/README.md | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/scripts/vms/ubuntu-14/README.md b/scripts/vms/ubuntu-14/README.md index a368401..2172209 100644 --- a/scripts/vms/ubuntu-14/README.md +++ b/scripts/vms/ubuntu-14/README.md @@ -64,11 +64,10 @@ download Pip, as it crashes the Python SDK. ## Starting the Virtual Machine up for the first time -The initial images are created by the `reset-*` scripts - -``` -./reset-main-drive.sh -``` +The initial images are created by the `reset-main-drive.sh` and `first-boot.sh` +scripts. The former creates a QCOW2 image that will perform as the virtual +machine's or guest system's hard drive, and the latter will boot the VM with +the Ubuntu 14 LTS installation disk. With the drives created, run the initialisation script and install a regular Ubuntu 14.04 LTS installation: @@ -84,10 +83,6 @@ The scripts expect an *unified root* partition scheme. Do not split `/home` or other directories into other partitions unless you know how to modify the scripts that copy data into or from the virtual machine or guest system. -``` -./first-boot.sh -``` - ## Running the VM Sometimes the Brazilian server takes too long to synchronise with the main From 5c192fdc34fa5b220ae1614d2f3739cbc31b3ddf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Davi=20Ant=C3=B4nio=20da=20Silva=20Santos?= Date: Sun, 5 Nov 2023 16:37:18 -0300 Subject: [PATCH 06/16] docs: explica scripts iniciais da VM do NAO6 --- scripts/vms/ubuntu-16/README.md | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/scripts/vms/ubuntu-16/README.md b/scripts/vms/ubuntu-16/README.md index b3b838f..6db9d1e 100644 --- a/scripts/vms/ubuntu-16/README.md +++ b/scripts/vms/ubuntu-16/README.md @@ -62,11 +62,10 @@ using the `install-naov6.sh` script. ## Starting the Virtual Machine up for the first time -The initial images are created by the `reset-*` scripts - -``` -./reset-main-drive.sh -``` +The initial images are created by the `reset-main-drive.sh` and `first-boot.sh` +scripts. The former creates a QCOW2 image that will perform as the virtual +machine's or guest system's hard drive, and the latter will boot the VM with +the Ubuntu 16 LTS installation disk. With the drives created, run the initialisation script and install a regular Ubuntu 16.04 LTS installation: @@ -76,10 +75,6 @@ Ubuntu 16.04 LTS installation: - Timezone: Sao Paulo - User: softex -``` -./first-boot.sh -``` - ## Running the VM Sometimes the Brazilian server takes too long to synchronise with the main From edc5dc48cdf8ac8c905cb36681eb2688383ca116 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Davi=20Ant=C3=B4nio=20da=20Silva=20Santos?= Date: Sun, 5 Nov 2023 16:38:49 -0300 Subject: [PATCH 07/16] =?UTF-8?q?docs:=20explica=20configura=C3=A7=C3=A3o?= =?UTF-8?q?=20da=20VM=20Ubuntu=2016?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- scripts/vms/ubuntu-16/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/scripts/vms/ubuntu-16/README.md b/scripts/vms/ubuntu-16/README.md index 6db9d1e..e84c9e9 100644 --- a/scripts/vms/ubuntu-16/README.md +++ b/scripts/vms/ubuntu-16/README.md @@ -70,10 +70,10 @@ the Ubuntu 16 LTS installation disk. With the drives created, run the initialisation script and install a regular Ubuntu 16.04 LTS installation: -- Language and keyboard layout: Português Brasileiro +- Language and keyboard layout: Português Brasileiro (or other UTF-8 locale) - Erase disk and install Ubuntu -- Timezone: Sao Paulo -- User: softex +- Timezone: Sao Paulo (or your local timezone) +- User: softex (must be the one specified in `VM_USER` in `env-vars.sh`) ## Running the VM From 9558f193546334557c4a12a01bb207b3e1e1eec4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Davi=20Ant=C3=B4nio=20da=20Silva=20Santos?= Date: Sun, 5 Nov 2023 16:39:53 -0300 Subject: [PATCH 08/16] =?UTF-8?q?docs:=20adiciona=20aviso=20sobre=20parti?= =?UTF-8?q?=C3=A7=C3=B5es=20Ubuntu=2016?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- scripts/vms/ubuntu-16/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/scripts/vms/ubuntu-16/README.md b/scripts/vms/ubuntu-16/README.md index e84c9e9..afe69cd 100644 --- a/scripts/vms/ubuntu-16/README.md +++ b/scripts/vms/ubuntu-16/README.md @@ -75,6 +75,12 @@ Ubuntu 16.04 LTS installation: - Timezone: Sao Paulo (or your local timezone) - User: softex (must be the one specified in `VM_USER` in `env-vars.sh`) +### WARNING + +The scripts expect an *unified root* partition scheme. Do not split `/home` or +other directories into other partitions unless you know how to modify the +scripts that copy data into or from the virtual machine or guest system. + ## Running the VM Sometimes the Brazilian server takes too long to synchronise with the main From e7a8fd441d43c02cd8885cdaa98df58b8348dd4b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Davi=20Ant=C3=B4nio=20da=20Silva=20Santos?= Date: Sun, 5 Nov 2023 16:44:45 -0300 Subject: [PATCH 09/16] docs: adiciona tutorial do guestfish VM NAO6 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Explica como usar o guestfish para copiar arquivos do sistema para a máquina virtual Ubuntu 16 do NAOv6. --- scripts/vms/ubuntu-16/README.md | 59 +++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) diff --git a/scripts/vms/ubuntu-16/README.md b/scripts/vms/ubuntu-16/README.md index afe69cd..9f534b3 100644 --- a/scripts/vms/ubuntu-16/README.md +++ b/scripts/vms/ubuntu-16/README.md @@ -337,3 +337,62 @@ reconfiguration event. You should be able to reset nftables to its standard configuration using the command: `nft flush ruleset`. This will break the network for the containers until the machine or the Docker service unit are restarted. + +## How to manually add files to the Virtual Machine + +You may want to add files from the host system, your current machine, to the +guest one, stored in the virtual machines. An usual way to do it is through SSH, +but it requires configuring an SSH server in the guest and a client in the host. + +A quicker way is to add the files directly to the virtual machine images. This +approach requires that the VMs must not be in execution, unlike the SSH-based +one. It is most convenient to use `guestfish`, a system shell that specialises +in manipulating virtual machine images, to manually add files to the VMs. + +You may create a script based on `inject-home.sh`, or use `guestfish` on its +interactive mode, which works similarly to the usual system shell. Even though +it requires more typing, the latter approach is more user-friendly and will be +explored in this tutorial. + +Firstly, you must know the path to the files that you wish to add to your VM and +their desired location in the virtual machine. These will be parameters that +will be used in `guestfish`'s `copy-in` command, responsible for copying files +*into* the VM. + +Then you must mount the virtual machine's partition that holds the output path. +This is the more cumbersome stage, as it requires knowing which partitions are +included in the virtual machine's image file. If you followed the previous +instructions and installed the VM using the recommended settings, you will be +able to use the following commands after executing `guestfish` on your terminal +with the working directory pointing where the image is located: + +``` + /dev/null; echo "add '${DISK_LOCATION}'" +run +mount '/dev/sda2' '/' +``` + +With the main partition mounted, you may use the `ls` command to list files and +directories. Copying files into the VM is done though the `copy-in` command: + +``` +# copying a file or directory from the current host directory +copy-in my-file-or-directory /home/softex +# copying a file or directory from an absolute path in the host +copy-in /absolute/path/in/the/host/something /desired/path/in/the/vm +``` + +The scripts use a more complicated syntax to automatically obtain the user that +has been configured in the `env-vars.sh` file: + +``` + /dev/null; echo "copy-in 'my-file' '/home/${VM_USER}/abc'" +``` + +After copying all the desired files, do not forget to unmount all the partitions +and close `guestfish` before running the VM: + +``` +umount-all +exit +``` \ No newline at end of file From dc0bd4c22aa9b5f6f54c8f8ac655b263ebf6895e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Davi=20Ant=C3=B4nio=20da=20Silva=20Santos?= Date: Sun, 5 Nov 2023 17:03:06 -0300 Subject: [PATCH 10/16] =?UTF-8?q?docs:=20explicar=20o=20porqu=C3=AA=20do?= =?UTF-8?q?=20Ubuntu=2014=20para=20NAO4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- scripts/vms/ubuntu-14/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/scripts/vms/ubuntu-14/README.md b/scripts/vms/ubuntu-14/README.md index 2172209..b16c86e 100644 --- a/scripts/vms/ubuntu-14/README.md +++ b/scripts/vms/ubuntu-14/README.md @@ -40,6 +40,14 @@ variable at the `env-vars.sh` script) [1]: https://releases.ubuntu.com/trusty/ubuntu-14.04.6-desktop-amd64.iso +The GNU/Linux distribution for fully installing NAOv4's programming environment +is Ubuntu 14.04 LTS. It is highly possible that one may be able to run it on the +equivalent Debian release. + +If the user wishes to **only** develop programs using NAOv4's C++98 API, it +*may* be possible to use a newer GNU/Linux distribution, provided that it has +support for Python 2 and Pip 20.3.4. + ### Creating the VM and preparing to compile NAOqi for NAOv4 The user must run in their host machine the scripts inside this repository in From 74427a3cad67ddf0e09787319216a83cc39e0e4d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Davi=20Ant=C3=B4nio=20da=20Silva=20Santos?= Date: Sun, 5 Nov 2023 17:23:00 -0300 Subject: [PATCH 11/16] =?UTF-8?q?docs:=20explicar=20o=20porqu=C3=AA=20do?= =?UTF-8?q?=20Ubuntu=2016=20para=20NAO6?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- scripts/vms/ubuntu-16/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/scripts/vms/ubuntu-16/README.md b/scripts/vms/ubuntu-16/README.md index 9f534b3..af1fa22 100644 --- a/scripts/vms/ubuntu-16/README.md +++ b/scripts/vms/ubuntu-16/README.md @@ -40,6 +40,14 @@ variable at the `env-vars.sh` script) [1]: https://releases.ubuntu.com/releases/xenial/ubuntu-16.04.7-desktop-amd64.iso +The GNU/Linux distribution for fully installing NAOv4's programming environment +is Ubuntu 16.04 LTS. It is highly possible that one may be able to run it on the +equivalent Debian release. + +If the user wishes to **only** develop programs using NAOv4's C++11 API, it +*may* be possible to use a newer GNU/Linux distribution, provided that it has +support for Python 2 and Pip 20.3.4. + ### Creating the VM and preparing to compile NAOqi for NAOv6 The user must run in their host machine the scripts inside this repository in From 11e3ef2d2436ef76e60b28de0789ad9ac8764731 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Davi=20Ant=C3=B4nio=20da=20Silva=20Santos?= Date: Sun, 5 Nov 2023 17:49:13 -0300 Subject: [PATCH 12/16] docs: Explica uso do naoqi simulado do NAOv4 --- scripts/vms/ubuntu-14/README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/scripts/vms/ubuntu-14/README.md b/scripts/vms/ubuntu-14/README.md index b16c86e..4999837 100644 --- a/scripts/vms/ubuntu-14/README.md +++ b/scripts/vms/ubuntu-14/README.md @@ -323,7 +323,29 @@ qibuild configure -c "${NAOQI_QIBUILD_CTC_CONFIG}" qibuild make -c "${NAOQI_QIBUILD_CTC_CONFIG}" ``` -## Connecting to the Robot +## Connecting to the simulated robot + +The simulated robot is an executable located in the C++ toolchain directory +named `naoqi`. Provided that the tools were installed with the aforementioned +scripts in their default configuration, it will be located at +`/home/softex/NAO4/SDKs/cpp/naoqi-sdk-2.1.4.13-linux64/naoqi`. + +The simulated robot must always be initialised before running Choregraphe or +your desired module. It will behave similarly to a physical robot, except by its +lack of cameras, and it will by default initialise its *broker* at *localhost*, +also known as IPv4 127.0.0.1, at the port 9559. + +### Simulating in Choregraphe + +If you wish to simulate your C++ module in Choregraphe, first you should start +the simulated `naoqi`. After doing it, then you must open Choregraphe, and +connect it to the broker available at 127.0.0.1 port 9559. + +After these steps you should see a 3D simulation of a NAO robot in the +Robot View panel. At this stage you are ready to connect to the simulated robot +and check how it behaves in the simplified simulation offered by Choregraphe. + +## Connecting to the robot There are three scripts that are used when connecting the Virtual Machine to your NAO: From 521e50c93307dd52fc5c13e7eb5ec0ec9cc0d3d9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Davi=20Ant=C3=B4nio=20da=20Silva=20Santos?= Date: Sun, 5 Nov 2023 17:51:50 -0300 Subject: [PATCH 13/16] docs: Explica uso do naoqi simulado do NAOv6 --- scripts/vms/ubuntu-16/README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/scripts/vms/ubuntu-16/README.md b/scripts/vms/ubuntu-16/README.md index af1fa22..4498152 100644 --- a/scripts/vms/ubuntu-16/README.md +++ b/scripts/vms/ubuntu-16/README.md @@ -320,6 +320,28 @@ qibuild configure -c "${NAOQI_QIBUILD_CTC_CONFIG}" qibuild make -c "${NAOQI_QIBUILD_CTC_CONFIG}" ``` +## Connecting to the simulated robot + +The simulated robot is an executable located in the C++ toolchain directory +named `naoqi`. Provided that the tools were installed with the aforementioned +scripts in their default configuration, it will be located at +`/home/softex/NAO6/SDKs/cpp/naoqi-sdk-2.8.5.10-linux64/naoqi`. + +The simulated robot must always be initialised before running Choregraphe or +your desired module. It will behave similarly to a physical robot, except by its +lack of cameras, and it will by default initialise its *broker* at *localhost*, +also known as IPv4 127.0.0.1, at the port 9559. + +### Simulating in Choregraphe + +If you wish to simulate your C++ module in Choregraphe, first you should start +the simulated `naoqi`. After doing it, then you must open Choregraphe, and +connect it to the broker available at 127.0.0.1 port 9559. + +After these steps you should see a 3D simulation of a NAO robot in the +Robot View panel. At this stage you are ready to connect to the simulated robot +and check how it behaves in the simplified simulation offered by Choregraphe. + ## Connecting to the Robot There are three scripts that are used when connecting the Virtual Machine to From c6b837b306769b2d55ee98f122f999d656ed3e44 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Davi=20Ant=C3=B4nio=20da=20Silva=20Santos?= Date: Sun, 5 Nov 2023 18:49:26 -0300 Subject: [PATCH 14/16] =?UTF-8?q?docs:=20adiciona=20p=C3=A1gina=20de=20exe?= =?UTF-8?q?mplos=20C++=20e=20ROS1=20nativo?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- mkdocs.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 9b6e802..a335278 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -84,6 +84,7 @@ nav: - NAO Flahser: Instruções/NAO_Flasher.md - SDK C++: Instruções/CPP_SDK_v4.md - Choregraphe: Instruções/Choregraphe_v4.md + - C++ examples: naoqi-2.1/cpp/about-the-examples.md - Trabalhando com o v6: - Introdução ao NAOqi: Instruções/NAOqi-overview_v6.md - Máquina Virtual com scripts: vms/ubuntu-16/README.md @@ -97,6 +98,7 @@ nav: - Precompiled: ros1/installing-precompiled-packages.md - Compiling: ros1/compiling-for-amd64-based-systems.md - Compiling for SBCs: ros1/compiling-for-arm-based-systems.md + - Native packages: ros1/installing-native-packages.md - ROS2: - General: ros2/general-instructions.md - Precompiled: ros2/installing-precompiled-packages.md @@ -104,4 +106,4 @@ nav: - Compiling for SBCs: ros2/compiling-for-arm-based-systems.md - Marcos: release/index.md - Equipe: sobre/equipe.md - - Sobre: sobre/sobre.md \ No newline at end of file + - Sobre: sobre/sobre.md From fda22119e6b5ee31dffa14fbb216f06a178a2361 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Davi=20Ant=C3=B4nio=20da=20Silva=20Santos?= Date: Sun, 5 Nov 2023 19:11:01 -0300 Subject: [PATCH 15/16] fix: renomeia arquivos que causam problema no mkdocs Os arquivos foram renomeados pois o MkDocs tenta acrescentar um comportamento especial aos arquivos nomeados como README.md. --- docs/vms/ubuntu-14/README.md | 1 - docs/vms/ubuntu-14/how-to-use.md | 1 + docs/vms/ubuntu-16/README.md | 1 - docs/vms/ubuntu-16/how-to-use.md | 1 + mkdocs.yml | 4 ++-- scripts/vms/ubuntu-14/{README.md => how-to-use.md} | 0 scripts/vms/ubuntu-16/{README.md => how-to-use.md} | 0 7 files changed, 4 insertions(+), 4 deletions(-) delete mode 120000 docs/vms/ubuntu-14/README.md create mode 120000 docs/vms/ubuntu-14/how-to-use.md delete mode 120000 docs/vms/ubuntu-16/README.md create mode 120000 docs/vms/ubuntu-16/how-to-use.md rename scripts/vms/ubuntu-14/{README.md => how-to-use.md} (100%) rename scripts/vms/ubuntu-16/{README.md => how-to-use.md} (100%) diff --git a/docs/vms/ubuntu-14/README.md b/docs/vms/ubuntu-14/README.md deleted file mode 120000 index 2973c1d..0000000 --- a/docs/vms/ubuntu-14/README.md +++ /dev/null @@ -1 +0,0 @@ -../../../scripts/vms/ubuntu-14/README.md \ No newline at end of file diff --git a/docs/vms/ubuntu-14/how-to-use.md b/docs/vms/ubuntu-14/how-to-use.md new file mode 120000 index 0000000..436cc2b --- /dev/null +++ b/docs/vms/ubuntu-14/how-to-use.md @@ -0,0 +1 @@ +../../../scripts/vms/ubuntu-14/how-to-use.md \ No newline at end of file diff --git a/docs/vms/ubuntu-16/README.md b/docs/vms/ubuntu-16/README.md deleted file mode 120000 index 33aab63..0000000 --- a/docs/vms/ubuntu-16/README.md +++ /dev/null @@ -1 +0,0 @@ -../../../scripts/vms/ubuntu-16/README.md \ No newline at end of file diff --git a/docs/vms/ubuntu-16/how-to-use.md b/docs/vms/ubuntu-16/how-to-use.md new file mode 120000 index 0000000..8adf730 --- /dev/null +++ b/docs/vms/ubuntu-16/how-to-use.md @@ -0,0 +1 @@ +../../../scripts/vms/ubuntu-16/how-to-use.md \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index a335278..d3c5fbd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -80,14 +80,14 @@ nav: - Primeiros Passos: Instruções/Maquina_Virtual.md - Trabalhando com o v4: - Introdução ao NAOqi: Instruções/NAOqi-overview_v4.md - - Máquina Virtual com scripts: vms/ubuntu-14/README.md + - Máquina Virtual com scripts: vms/ubuntu-14/how-to-use.md - NAO Flahser: Instruções/NAO_Flasher.md - SDK C++: Instruções/CPP_SDK_v4.md - Choregraphe: Instruções/Choregraphe_v4.md - C++ examples: naoqi-2.1/cpp/about-the-examples.md - Trabalhando com o v6: - Introdução ao NAOqi: Instruções/NAOqi-overview_v6.md - - Máquina Virtual com scripts: vms/ubuntu-16/README.md + - Máquina Virtual com scripts: vms/ubuntu-16/how-to-use.md - Robot Settings: Instruções/Robot_Settings.md - SDK C++: Instruções/CPP_SDK_v6.md - Choregraphe: Instruções/Choregraphe_v6.md diff --git a/scripts/vms/ubuntu-14/README.md b/scripts/vms/ubuntu-14/how-to-use.md similarity index 100% rename from scripts/vms/ubuntu-14/README.md rename to scripts/vms/ubuntu-14/how-to-use.md diff --git a/scripts/vms/ubuntu-16/README.md b/scripts/vms/ubuntu-16/how-to-use.md similarity index 100% rename from scripts/vms/ubuntu-16/README.md rename to scripts/vms/ubuntu-16/how-to-use.md From 9f484e382e26424ff91d2a62a942f93cf36f6a00 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Davi=20Ant=C3=B4nio=20da=20Silva=20Santos?= Date: Sun, 5 Nov 2023 19:18:15 -0300 Subject: [PATCH 16/16] =?UTF-8?q?docs:=20muda=20para=20ingl=C3=AAs=20as=20?= =?UTF-8?q?p=C3=A1ginas=20neste=20idioma?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit As páginas de scripts estão em inglês, logo o título na `nav` foi modificado. --- mkdocs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index d3c5fbd..a467af9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -80,14 +80,14 @@ nav: - Primeiros Passos: Instruções/Maquina_Virtual.md - Trabalhando com o v4: - Introdução ao NAOqi: Instruções/NAOqi-overview_v4.md - - Máquina Virtual com scripts: vms/ubuntu-14/how-to-use.md + - QEMU-based Virtual Machine and installation scripts: vms/ubuntu-14/how-to-use.md - NAO Flahser: Instruções/NAO_Flasher.md - SDK C++: Instruções/CPP_SDK_v4.md - Choregraphe: Instruções/Choregraphe_v4.md - C++ examples: naoqi-2.1/cpp/about-the-examples.md - Trabalhando com o v6: - Introdução ao NAOqi: Instruções/NAOqi-overview_v6.md - - Máquina Virtual com scripts: vms/ubuntu-16/how-to-use.md + - QEMU-based Virtual Machine and installation scripts: vms/ubuntu-16/how-to-use.md - Robot Settings: Instruções/Robot_Settings.md - SDK C++: Instruções/CPP_SDK_v6.md - Choregraphe: Instruções/Choregraphe_v6.md