Skip to content
This repository has been archived by the owner on Mar 17, 2021. It is now read-only.

Tidy up multi-simulation doc #835

Merged
merged 1 commit into from
Jul 10, 2019
Merged

Conversation

hamishwillee
Copy link
Collaborator

Minor tidy up to doc following #825.

@lamping7 I will merge this, but would be good if you cold sanity check I did not change the meaning.

Note there are just a couple of points inline I have made to explain layout changes.

@@ -62,7 +60,7 @@ For each simulated vehicle, the following is required:
The launch file `multi_uav_mavros_sitl.launch`does the following,

* loads a world in gazebo,
```
```
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lamping7
Note

  1. Typically use three backticks on a new line for a block of code and single backticks for an inline code. With a block you can specify the programming language for syntax highlighting (I have not done this here).
  2. The backticks and blocks have to be indented next to the text in the bullet - in this case 2 spaces.

To add a new vehicle, you need to make sure the model can be found (in order to spawn it in Gazebo), and PX4 needs to have an appropriate corresponding startup script.

1. You can choose to do either of:
* modify the **single_vehicle_spawn_sdf.launch** file to point to the location of your model by changing the line below to point to your model:
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tend to use bold for filenames, italic for tool names, and code for code or command line invocations.

@hamishwillee hamishwillee merged commit 2f611b5 into PX4:master Jul 10, 2019
@lamping7
Copy link
Member

LGTM

@hamishwillee
Copy link
Collaborator Author

Thanks for review!

@hamishwillee hamishwillee deleted the multisdf_tidy branch July 11, 2019 00:21
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants