summaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorThanos Apollo <[email protected]>2023-02-10 05:23:29 +0200
committerThanos Apollo <[email protected]>2023-02-10 05:23:29 +0200
commit5ad60096c4980f0910a667afa5c5ff685cc1cce2 (patch)
tree550e56525b752daaaf4d15ba64344d9de584e9ee /README.org
parentf2ac9d5f8bcb91a01e0e313faba4205c31824a15 (diff)
update readme
Diffstat (limited to 'README.org')
-rw-r--r--README.org42
1 files changed, 42 insertions, 0 deletions
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*
+
+