readme: Comment out pics, add markdown at /

2 files changed, 73 insertions, 7 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..23415fe
--- /dev/null
+++ b/README.md
@@ -0,0 +1,65 @@
+
+# Table of Contents
+
+-   [About](#org4cfc3ae)
+-   [Configurations](#orge4a2806)
+-   [Installation](#org476ea37)
+-   [WARNING!](#org30fa10a)
+
+
+
+<a id="org4cfc3ae"></a>
+
+# 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 [GNU Stow](https://www.gnu.org/software/stow/), which allows me to easily manage and switch between different configurations for different systems or environments.
+
+
+<a id="orge4a2806"></a>
+
+# Configurations
+
+Themes I'm using:  
+
+-   [Dracula for rofi](https://github.com/dracula/rofi)
+-   [Dracula for nyxt](https://github.com/dracula/nyxt)
+-   [Dracula for Qutebrowser](https://github.com/dracula/qutebrowser)
+-   [mocp-themes](https://github.com/wimstefan/mocp-themes) collection
+
+
+<a id="org476ea37"></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
+
+-   Use stow
+
+    cd ~/dotfiles
+    stow . 
+
+If you get any errors due to existing files, rename them with `_backup` at the end
+
+e.g `mv ~/.bashrc ~/.bashrc_backup`
+
+
+<a id="org30fa10a"></a>
+
+# 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.
+
diff --git a/org/README.org b/org/README.org
index 42d4920..2832093 100755
--- a/org/README.org
+++ b/org/README.org
@@ -1,6 +1,8 @@
 #+title: Dotfiles | My Linux setup
-#+OPTIONS: num:nil toc:nil
+#+OPTIONS: num:nil toc:t
 #+STARTUP: overview
+#+SETUPFILE: org-sourcehut/sourcehut.setup
+#+export_file_name: ../README.md
 * About
 
 Welcome to my dotfiles repository!
@@ -9,15 +11,14 @@ Here you will find my custom configuration files for a variety of applications a
 
 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]]
+# + [[file:emacs.org][Emacs]]
+# + [[file:shells.org][Shells]]
+# + [[file:Qtile.org][Qtile]]
     
-/Qtile with emacs/
- [[file:pictures/showcase2.png]]
+# /Qtile with emacs/
+#  [[file:pictures/showcase2.png]]
 
 Themes I'm using:  
 + [[https://github.com/dracula/rofi][Dracula for rofi]]