Merge pull request #2 from ThanosApollo/update-doc

Update doc

1 files changed, 31 insertions, 0 deletions

diff --git a/doc.org b/doc.org
new file mode 100644
index 0000000..9b88813
--- /dev/null
+++ b/doc.org
@@ -0,0 +1,31 @@
+#+title: Dotfiles | My Linux setup
+#+export_file_name: README.md
+#+OPTIONS: num:nil
+
+* 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/
+ [[file:pictures/showcase.png]]
+
+* Installation
++ clone repository
+
+#+begin_src bash
+  git clone https://github.com/ThanosApollo/dotfiles.git ~/dotfiles
+#+end_src
++ Install [[https://www.gnu.org/software/stow/][GNU stow]]
+  
+#+begin_src bash
+  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
+#+end_src  
+
+* 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*
+