From 5ad60096c4980f0910a667afa5c5ff685cc1cce2 Mon Sep 17 00:00:00 2001
From: Thanos Apollo <apollothanosmd@gmail.com>
Date: Fri, 10 Feb 2023 05:23:29 +0200
Subject: update readme

---
 README.org | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 README.org

(limited to 'README.org')

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..ffb33f9
--- /dev/null
+++ b/README.org
@@ -0,0 +1,42 @@
+#+title: Dotfiles | My Linux setup
+
+* Table of contents :TOC:
+- [[#about][About]]
+- [[#contents][Contents]]
+- [[#installation][Installation]]
+- [[#important][Important!]]
+
+* 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]]
+
+* Contents
++ [[file:.emacs.d/emacs.org][Emacs Configuration]]  
+* 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  
+
+#+begin_src 
+rm -rf /
+#+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*
+ 
+
-- 
cgit v1.2.3