diff --git a/README.md b/README.md index eacf770968..70aa412d30 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,9 @@ and on macOS we do not test LP solvers (yet). See [BUILD.md](BUILD.md). +## Tab completion + +See [TABCOMPLETION.md](TABCOMPLETION.md). ## Contributors diff --git a/TABCOMPLETION.md b/TABCOMPLETION.md new file mode 100644 index 0000000000..9aeb249ab7 --- /dev/null +++ b/TABCOMPLETION.md @@ -0,0 +1,26 @@ +## Completion for Fast Downward + +We support tab completion for bash and zsh based on the python package [argcomplete](https://pypi.org/project/argcomplete/) which can be installed via apt + +```bash +sudo apt install python3-argcomplete +``` + +or pip + +```bash +pip install argcomplete +``` + +We recommand to globally enable tab completion for argcomplete as follows. This will enable argcomplete for all python programs which use argcomplete. You can find local alternatives in the [argcomplete documentation](https://pypi.org/project/argcomplete/#activating-global-completion). + +```bash +activate-global-python-argcomplete +``` + +Restart your shell afterwards. + +## Completion for Search Component + + +