1 files changed, 54 insertions, 0 deletions
diff --git a/org/README.org b/org/README.org
new file mode 100755
index 0000000..42d4920
--- /dev/null
+++ b/org/README.org
@@ -0,0 +1,54 @@
+#+title: Dotfiles | My Linux setup
+#+OPTIONS: num:nil toc:nil
+#+STARTUP: overview
+* About
+
+Welcome to my dotfiles repository!
+
+Here you will find my custom configuration files for a variety of applications and utilities. All of which are written in org-mode literate configuration format.
+
+All of the configurations in this repository are managed using [[https://www.gnu.org/software/stow/][GNU Stow]], which allows me to easily manage and switch between different configurations for different systems or environments.
+
+- Hosted at [[https://git.sr.ht/~thanos_apollo/dotfiles][sourcehut]]
+  
+* Configurations
++ [[file:emacs.org][Emacs]]
++ [[file:shells.org][Shells]]
++ [[file:Qtile.org][Qtile]]
+    
+/Qtile with emacs/
+ [[file:pictures/showcase2.png]]
+
+Themes I'm using:  
++ [[https://github.com/dracula/rofi][Dracula for rofi]]
++ [[https://github.com/dracula/nyxt][Dracula for nyxt]]
++ [[https://github.com/dracula/qutebrowser][Dracula for Qutebrowser]]
++ [[https://github.com/wimstefan/mocp-themes][mocp-themes]] collection      
+ 
+* 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
+#+end_src
++ Use stow
+#+begin_src bash
+  cd ~/dotfiles
+  stow . 
+#+end_src
+If you get any errors due to existing files, rename them with ~_backup~ at the end
+
+e.g ~mv ~/.bashrc ~/.bashrc_backup~
+* WARNING!
+It's important to note that my dotfiles in this repository are constantly evolving, as I am constantly experimenting with new configurations and settings.
+
+While I am happy to share my configurations, *I do not recommend using them as-is on your own system* without careful review and testing.
+
+It's possible that some configurations may not work as expected or may cause issues on your system. Therefore, I strongly recommend taking caution and reviewing any changes carefully before applying them to your own system.
+ 
+