From 5cd763046891ea9b7b39cf4e03ab95bb85ed6101 Mon Sep 17 00:00:00 2001
From: Claudio Maradonna <claudio@unitoo.pw>
Date: Thu, 5 Aug 2021 10:01:53 +0200
Subject: [PATCH] feature: Add README for doom-emacs config

---
 emacs/doom-emacs/README.md | 40 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 emacs/doom-emacs/README.md

diff --git a/emacs/doom-emacs/README.md b/emacs/doom-emacs/README.md
new file mode 100644
index 0000000..02b9a66
--- /dev/null
+++ b/emacs/doom-emacs/README.md
@@ -0,0 +1,40 @@
+# Doom-Emacs configuration
+
+# Quick setup
+
+1. Copy those files in the `~/.doom.d` folder
+2. Adjust `init.el` file with your preferences
+3. Add/ Remove `hooks` from `config.el`
+4. Follow [doom-emacs install](https://github.com/hlissner/doom-emacs#install)
+
+# Tips
+
+* every time you change your `init.el` file, run `~/.emacs.d/bin/doom sync`
+* to check missing modules, packages or dependencies use `~/.emacs.d/bin/doom doctor` and follow specific instructions
+
+## Our config
+
+### Languages
+
+* Common LISP
+* Emacs LISP
+* Go
+* Haskell
+* JSON
+* Javascript
+* Markdown
+* PHP
+* Python
+* Ruby
+* Rust
+* Sh
+* Web (Generic module)
+* Yaml
+
+### Other packages
+
+* LSP + Company -> autocompletion
+* iBuffer -> buffer management
+* docker -> docker commands and shortcuts
+* magit
+* workspace -> project isolated spaces