From f617a7139d04ee637ed4d58b37f32e62b6058f5b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Davi=20Ant=C3=B4nio=20da=20Silva=20Santos?= Date: Sat, 25 Nov 2023 18:40:19 -0300 Subject: [PATCH] =?UTF-8?q?docs:=20adiciona=20arquivo=20explicando=20diret?= =?UTF-8?q?=C3=B3rios?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Adicionou-se um arquivo explicando a estrutura de diretórios do diretório `scripts`, fundamental para a navegação pelo repositório. --- scripts/navegando.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 scripts/navegando.md diff --git a/scripts/navegando.md b/scripts/navegando.md new file mode 100644 index 0000000..3de5d37 --- /dev/null +++ b/scripts/navegando.md @@ -0,0 +1,24 @@ +# Navegando pelo diretório de scripts + +O diretório de scripts contém a maior parte do projeto. Ele é composto pelos +scripts usados para gerar as máquinas virtuais (VMs) do NAOv4 e do NAOv6, e +pelos scripts usados para compilar o ROS1 e ROS2, bem como a documentação do +projeto, que é copiada para o diretório `docs` através de *links* simbólicos +gerados pelo script localizado em `03_Robotica/docs/mkdocs-kludge.sh`. + +## O conteúdo dos diretórios + +Segue abaixo o conteúdo de cada um dos diretórios e uma breve explicação sobre +cada um deles. Os níveis dos tópicos indicam os subdiretórios dentro de um +diretório. + +- `ros1`: contém os scripts e a documentação que lidam com a compilação ou +instalação do ROS1 Noetic. +- `ros2`: contém os scripts e a documentação que se referem a compilação ou +instalação do ROS2 Humble. +- `vms`: contém os diretórios referentes às máquinas virtuais do NAOv4 e do +NAOv6: + - `ubuntu-14`: contém os scripts e a documentação da máquina virtual do + NAOv4. + - `ubuntu-16`: contém os scripts e a documentação da máquina virtual do + NAOv6.