From 5d0eeb22923b46c49e26c8ce429c662f6f0dcd3f Mon Sep 17 00:00:00 2001
From: Lorenzo Tucci <yamabiiko@protonmail.com>
Date: Sat, 10 Apr 2021 16:24:53 +0200
Subject: [PATCH] edit readme

---
 README.md | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 8ca999b..6d3da0a 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,23 @@
 # dot-files
 
-Unitoo standardized dotfiles.
\ No newline at end of file
+Unitoo standardized dotfiles.
+
+## Directory Logic
+
+The directory tree logic is the following: program_name/program_name.conf and
+eventually an associated Markdown file program_name/program_name.md \
+OR program_name/path/to/conf/program_name.conf
+ && program_name/path/to/conf/program_name.conf \
+**Examples:** neovim/neovim.conf, nginx/etc/nginx/nginx.conf
+
+## Syntax highlighting
+
+To let Gitlab display the proper syntax highlighting, edit the .gitattribute file 
+accordingly:
+**Example:**
+
+ ```
+neovim/** gitlab-language=vim
+spacemacs/** gitlab-language=elisp
+ ```
+