Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update task names #46

Merged
merged 2 commits into from
Jul 11, 2024
Merged

Update task names #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b56445
Update task names
benjaminwp18 Jul 11, 2024
2a60797
Make READMEs clearer and update references to tasks
benjaminwp18 Jul 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions .vscode/tasks.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"version": "2.0.0",
"tasks": [
{
"label": "🏃‍♂️ ROS All",
"label": "[ROS] 🏃‍ Install Dependencies & Build Workspace",
"type": "shell",
"command": "bash",
"args": [
Expand All @@ -15,7 +15,7 @@
"problemMatcher": []
},
{
"label": "🏃‍♂️ ROS Quick Build",
"label": "[ROS] 🏃‍ Build Workspace",
"type": "shell",
"command": "bash",
"args": [
Expand Down Expand Up @@ -118,7 +118,7 @@
"problemMatcher": []
},
{
"label": "Setup MATE ROV Environment",
"label": "Add ROS to bashrc",
benjaminwp18 marked this conversation as resolved.
Show resolved Hide resolved
"type": "shell",
"command": "bash",
"args": [
Expand All @@ -127,16 +127,16 @@
"hide": true
},
{
"label": "Setup Surface Environment",
"label": "[SETUP] Surface Computer Environment",
"dependsOrder": "sequence",
"dependsOn": ["Install ROS", "Install Dependencies", "Setup MATE ROV Environment"],
"dependsOn": ["Install ROS", "Install Dependencies", "Add ROS to bashrc"],
"presentation": {
"revealProblems": "onProblem"
},
"problemMatcher": []
},
{
"label": "Setup Pi Environment",
"label": "[SETUP] Pi Environment",
"type": "shell",
"command": "bash",
"args": [
Expand All @@ -148,7 +148,7 @@
"problemMatcher": []
},
{
"label": "Setup Simulation",
"label": "[SETUP] Simulation",
"type": "shell",
"command": "bash",
"args": [
Expand Down
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,15 @@ Restart.

Then install the Dev Containers VSCode extension.

To open the container use `F1` or `ctrl+shift+p` to open the command bar and use `Tasks: Runs Task`. Then from the Task selection choose `Docker Rebuild`. This will build and run the docker container. Make sure to choose `ROV Linux` for which type to run.
To open the container, open the repository with VSCode. Then use `F1` or `ctrl+shift+p` to open the command bar and select `Tasks: Run Task`. Then from the Task selection choose `Docker Rebuild`. This will build and run the docker container. Make sure to choose `ROV Linux` for which type to run.

For gui apps run `xhost + local:docker` before launching docker or add to `.bashrc`.

To reopen after a build Go to File > Open Recent /stuff/rov-25 \[Dev Container]

#### Bare Metal

To run the install script use `F1` or `ctrl+shift+p` to open the command bar and use `Tasks: Runs Task`. Then from the Task selection choose `Setup Surface Environment`. This will install ROS and all our dependencies.
To run the install script, open the repository with VSCode. Then use `F1` or `ctrl+shift+p` to open the command bar and select `Tasks: Run Task`. Then from the Task selection choose `[SETUP] Surface Environment`. This will install ROS and all our dependencies.

### Windows

Expand All @@ -62,7 +62,7 @@ Start by installing docker from [here](https://www.docker.com/get-started/).

Then install the Dev Containers VSCode extension.

To open the container use `F1` or `ctrl+shift+p` to open the command bar and use `Tasks: Runs Task`. Then from the Task selection choose `Docker Rebuild`. This will build and run the docker container. Make sure to choose `ROV Windows` for which type to run.
To open the container, open the repository with VSCode. Then use `F1` or `ctrl+shift+p` to open the command bar and select `Tasks: Run Task`. Then from the Task selection choose `Docker Rebuild`. This will build and run the docker container. Make sure to choose `ROV Windows` for which type to run.

To add your ssh keys into the container follow [this](https://code.visualstudio.com/remote/advancedcontainers/sharing-git-credentials) guide.

Expand Down Expand Up @@ -90,7 +90,7 @@ After WSL has been installed follow [this](https://code.visualstudio.com/docs/re

Then run the install script.

To run the install script use `F1` or `ctrl+shift+p` to open the command bar and use `Tasks: Runs Task`. Then from the Task selection choose `Setup Surface Environment`. This will install ROS and all our dependencies.
To run the install script, open the repository with VSCode. Then use `F1` or `ctrl+shift+p` to open the command bar and select `Tasks: Run Task`. Then from the Task selection choose `[SETUP] Surface Environment`. This will install ROS and all our dependencies.

### macOS

Expand Down Expand Up @@ -119,7 +119,7 @@ Make the settings look like this:

![image](/doc/images/macos_xserver_settings.jpg)

To open the container use `F1` or `ctrl+shift+p` to open the command bar and use `Tasks: Runs Task`. Then from the Task selection choose `Docker Rebuild`. This will build and run the docker container. Make sure to choose `ROV macOS` for which type to run.
To open the container, open the repository with VSCode. Then use `F1` or `ctrl+shift+p` to open the command bar and select `Tasks: Run Task`. Then from the Task selection choose `Docker Rebuild`. This will build and run the docker container. Make sure to choose `ROV macOS` for which type to run.

To reopen after a build Go to File > Open Recent /stuff/rov-25 \[Dev Container]

Expand Down Expand Up @@ -153,7 +153,7 @@ corresponding option appear. Click or hit enter on that option.
This whole process should become `F1`, `Enter`, `Enter` once you've done it once,
although the magic of symlink should mean you won't need to build again for most things.

If you're working on package's `setup.py` or rov_msgs, you'll need to run `🏃‍♂️ ROS Quick Build` or use `Control + Shift + B` every time you change something.
If you're working on package's `setup.py` or rov_msgs, you'll need to run `[ROS] 🏃‍ Build Workspace` or use `Control + Shift + B` every time you change something.

If you want to run our unit tests use this command `colcon test --event-handlers=console_direct+`.

Expand Down
2 changes: 1 addition & 1 deletion src/surface/rov_gazebo/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Runs the simulation as well as stores all the description files.

## Installation

Run the `Setup Simulation` Task.
Run the `[SETUP] Simulation` Task.

## Usage

Expand Down