Add readme file

This commit is contained in:
Maciej Szlosarczyk 2017-04-27 08:00:09 +03:00
parent dbde8ceb3c
commit a4fe24a48b
No known key found for this signature in database
GPG key ID: 0D4EEACF63D4262E

34
README.md Normal file
View file

@ -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`).