diff --git a/README.md b/README.md new file mode 100644 index 0000000..8bdf53e --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# My emacs config + +Contains config I use for the following languages/modes: + +* Elixir +* Ruby +* Rust +* HTML and compatibile (ERB) +* Markdown + +## Installation + +```bash +git clone git@github.com:maciej-szlosarczyk/emacs.git ~/.emacs.d +ln -s ~/.emacs.d/emacs ~/.emacs +``` + + +## Selected packages + +The following packages are included or required: + +* Evil +* Magit +* Helm +* Projectile +* Company +* Yasnippet +* Column Enforce Mode +* Ag + +## Compatibility notes + +Tested on MacOS, requires additional packages such as ag (`the_silver_searcher`).