From a99f0dad95045d6ae1be75d2d76adc931e7d32bf Mon Sep 17 00:00:00 2001 From: Andrew Jong Date: Thu, 19 Dec 2024 17:38:54 -0500 Subject: [PATCH] Update docs --- CHANGELOG.md | 33 ++++++++++++++++++++++++++++++++ docs/development/docker_usage.md | 12 ++++-------- 2 files changed, 37 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e69de29b..c785ecc7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -0,0 +1,33 @@ + +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [1.0.0] - 2024-12-19 + +First official public release. + +### Added + +- Docker image robot-l4t for Jetson AGX +- Automatically load and play Isaac Sim scene upon launch +- Random walk planner +- DROAN trajectory-library based local planner +- Initial GCS rviz capable of visualizing multiple robots + +### Fixed + +- A bunch of stuff honestly + +### Changed + +- Upgrade Isaac Sim from 4.1.0 to 4.2.0 +- Unified docker image naming to use AirStack's version. +- Condensed GCS TAK docker images to single docker image + +### Removed + +- Duplicate TAK images diff --git a/docs/development/docker_usage.md b/docs/development/docker_usage.md index dd1f7355..f509e908 100644 --- a/docs/development/docker_usage.md +++ b/docs/development/docker_usage.md @@ -1,8 +1,8 @@ -# General Usage with Docker Compose +# Workflow with Docker and Docker Compose To mimic interacting with multiple real world robots, we use Docker Compose to manage Docker containers that isolate the simulation, each robot, and the ground control station. -The details of the docker compose setup is in `AirStack/docker-compose.yaml`. +The details of the docker compose setup is in the project root's `docker-compose.yaml`. In essence, the compose file launches: @@ -29,13 +29,9 @@ docker login airlab-storage.andrew.cmu.edu:5001 docker compose pull ``` -Catelog: [AirLab Registry Images](https://airlab-storage.andrew.cmu.edu:5001/v2/_catalog). +The available image tags are listed [here](https://airlab-storage.andrew.cmu.edu:5001/v2/shared/airstack/tags/list). -Available image tags: -[airstack-dev](https://airlab-storage.andrew.cmu.edu:5001/v2/shared/airstack-dev/tags/list), -[isaac-sim_ros-humble](https://airlab-storage.andrew.cmu.edu:5001/v2/shared/isaac-sim_ros-humble/tags/list) - -## Build Images +## Build Images From Scratch ```bash docker compose build