aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src
diff options
context:
space:
mode:
authorcrownedgrouse <[email protected]>2020-04-12 18:59:42 +0200
committerLoïc Hoguin <[email protected]>2020-04-21 11:20:16 +0200
commit2c2b9d3a0df19ca05e1da462b36eda7f2d050153 (patch)
tree15d54628740f9cdd79c2b8d4ac6ba87a78571907 /doc/src
parentc55d0dcd6182983521d4ab34478cfe4b093edb12 (diff)
downloaderlang.mk-2c2b9d3a0df19ca05e1da462b36eda7f2d050153.tar.gz
erlang.mk-2c2b9d3a0df19ca05e1da462b36eda7f2d050153.tar.bz2
erlang.mk-2c2b9d3a0df19ca05e1da462b36eda7f2d050153.zip
Add bash completion script
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/guide/getting_started.asciidoc25
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/src/guide/getting_started.asciidoc b/doc/src/guide/getting_started.asciidoc
index de40f36..be58e87 100644
--- a/doc/src/guide/getting_started.asciidoc
+++ b/doc/src/guide/getting_started.asciidoc
@@ -38,6 +38,31 @@ Alternatively, just https://erlang.mk/erlang.mk[click on this link].
Make sure you put the file inside the folder we created previously.
+==== Bash completion
+
+If your preferred shell is Bash, a completion script is available.
+In order to install it, use the following commands:
+
+[source,bash]
+----
+$ mkdir ~/.bash_completion.d/
+$ cd ~/.bash_completion.d/
+$ wget -O erlang_mk https://raw.githubusercontent.com/ninenines/erlang.mk/master/etc/bash_completion
+----
+
+Then edit the file `~/.bash_completion` and add:
+
+[source,bash]
+----
+for bcfile in ~/.bash_completion.d/* ; do
+ . $bcfile
+done
+----
+
+Note that Make's legacy Bash completion will be overwritten.
+If you need legacy completion for other C projects, consider sourcing
+Erlang.mk's Bash completion only in your Erlang project directory instead.
+
=== Getting started with OTP applications
An OTP application is an Erlang application that has a supervision