Merge pull request #4 from ThanosApollo/org-config

Redo as literate configurations emacs & shells

1 files changed, 45 insertions, 0 deletions

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..2d0555b
--- /dev/null
+++ b/README.org
@@ -0,0 +1,45 @@
+#+title: Dotfiles | My Linux setup
+
+* Table of contents :TOC:
+- [[#about][About]]
+- [[#contents][Contents]]
+- [[#installation][Installation]]
+- [[#warning][WARNING!]]
+
+* About
+
+Personal dotfiles, managed with GNU stow
+
+I use this repo to keep my configurations synchronized across different machines. Including a macOS laptop.
+  
+
+
+* Contents
++ [[file:.emacs.d/emacs.org][Emacs]]
++ [[file:shells.org][Shells]]
+  
+/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
+#+end_src
++ Run stow   /create and manage symlinks/
+#+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!
+*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*
+/My configuration is constantly changing, and I break things quite often./
+
+ 
+