inits file

1 files changed, 19 insertions, 0 deletions

diff --git a/elixir-tooling.md b/elixir-tooling.md
new file mode 100644
index 000000000000..9410fa1fe3af
--- /dev/null
+++ b/elixir-tooling.md
@@ -0,0 +1,19 @@
+# Elixir Tooling
+
+Disclaimer: This file is intended to document learnings about tooling text editors to work with Elixir.
+
+## Emacs
+
+### Useful plugins
+
+* `Elixir-mode`: font-locking, indentation, etc.
+* `Alchemist`: IEx, mix, autocompletion via `company`, etc.
+* `Flycheck`: works with linters, `Dogma` and `Credo`
+
+When running an umbrella app, to allow `Alchemist` to properly jump to function definitions run...
+
+```bash
+$ ln -sf ../../_build _build
+```
+
+...where `../../_build` is the path to the umbrella root directory.