Mirror
/
ardupilot
mirror of https://github.com/ArduPilot/ardupilot
5
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Tools: add readme for completion

This commit is contained in:
Pierre Kancir 2020-01-19 21:06:31 +01:00 committed by Peter Barker
parent b247f2830b
commit 2b9c6b08c2
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
Tools/completion/completion.md Normal file
View File

@ -0,0 +1,27 @@
## on Bash
To install the completion, you should either, source the main script on your current terminal or source the main script on your bash configuration.
### Direct use
From ArduPilot root directory, simply use :
```` bash
source ./Tools/completion/completion.bash
````
And now completion works from your terminal instance. If you close the terminal, the completion feature is removed.
### Permanent use
Edit you `.bashrc` file, it is on your Home directory but it is a hidden file (CTRL+H on Ubuntu to reveal them). Then put at the end of the file :
```` bash
source PATH_TO_ARDUPILOT_DIRECTORY/Tools/completion/completion.bash
````
where PATH_TO_ARDUPILOT_DIRECTORY is the path to ArduPilot directory.
### Usage
You can now abuse of your TAB key on `waf` and `sim_vehicle.py` call ! See the video at the end.
## On ZSH
Zsh don't allow live loading of completion. So you have to source the completion script in your `.zshrc` file. Like for Bash, you will find it hiding on your home !
Put at the end of the file :
```` bash
source PATH_TO_ARDUPILOT_DIRECTORY/Tools/completion/completion.zsh
````
where PATH_TO_ARDUPILOT_DIRECTORY is the path to ArduPilot directory. Notice the difference, the extension is `.zsh` !