Add readme | Produced by doc.org

1 files changed, 43 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9d43a84
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+
+# Table of Contents
+
+-   [About](#orgd76539e)
+-   [Installation](#org30a346a)
+-   [Important!](#org880a841)
+
+
+
+<a id="orgd76539e"></a>
+
+# About
+
+Personal dotfiles, managed with GNU stow
+
+I use this repo to keep my configurations synchronized across different machines. Including a macOS laptop.
+
+*Qtile with vanilla emacs*
+ ![img](pictures/showcase.png)
+
+
+<a id="org30a346a"></a>
+
+# Installation
+
+-   clone repository
+
+    git clone https://github.com/ThanosApollo/dotfiles.git ~/dotfiles
+
+-   Install [GNU stow](https://www.gnu.org/software/stow/)
+
+    guix install stow  # use the package manager of your distro if not guix
+    
+    cd ~/dotfiles
+    stow . # if you get errors, rename your files that produce them, e.g mv ~/.bashrc ~/.bashrc_backup
+
+
+<a id="org880a841"></a>
+
+# Important!
+
+**I do not recommend to run my dotfiles as is. Proceed with caution, you are better off copying parts of my code and implementing them in your own configuration**
+