From dcb1e4269d5355621ae2a6962f76b5657ca2b830 Mon Sep 17 00:00:00 2001 From: Thanos Apollo Date: Wed, 15 Feb 2023 03:33:25 +0200 Subject: readme: Update intro, fix link to emacs.org --- README.org | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'README.org') diff --git a/README.org b/README.org index da23762..311e9c3 100644 --- a/README.org +++ b/README.org @@ -8,12 +8,14 @@ * About -Personal dotfiles, managed with GNU stow +Welcome to my dotfiles repository! -I use this repo to keep my configurations synchronized across different machines. Including a macOS laptop. +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. * Configurations -+ [[file:.emacs.d/emacs.org][Emacs]] ++ [[file:emacs.org][Emacs]] + [[file:shells.org][Shells]] + [[file:Qtile.org][Qtile]] @@ -30,7 +32,7 @@ I use this repo to keep my configurations synchronized across different machines #+begin_src bash guix install stow # use the package manager of your distro if not guix #+end_src -+ Run stow /create and manage symlinks/ ++ Use stow #+begin_src bash cd ~/dotfiles stow . @@ -39,8 +41,6 @@ If you get any errors due to existing files, rename them with ~_backup~ at the e 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./ - +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. -- cgit v1.2.3