From 39aff6e6a08b9bfe0afab53f776c98428cfcd602 Mon Sep 17 00:00:00 2001 From: Anthony Rodriguez Date: Mon, 19 Jun 2023 14:35:46 +0200 Subject: [PATCH] update README --- README.org | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.org b/README.org index 340dd32..257aa7a 100644 --- a/README.org +++ b/README.org @@ -4,12 +4,17 @@ [[./screenshots/desktop-terminals.png]] These are my personal dotfiles for configuring my workstation. I use [[https://www.gnu.org/software/stow/][stow]] to manage them, hence why everything is under its own module, so I can use ~stow */~ to symlink them to the right place. + +This configuration uses git submodules in order to pull some plugins and to integrate my Emacs config in a separate repository, so make sure to initialize them before trying to install it (installation instructions below). + * Installing You could install it on any Linux distribution that you want, but I recommend Arch Linux as there is a file containing a list of required packages installable via pacman or your favorite AUR helper. - Clone the config in your home directory ~git clone git@github.com:nezia1/dotfiles.git ​~/.dotfiles~ +- Initialize submodules with ~git submodule update --init~ - If you're using Arch Linux, install the packages with ~sudo pacman ​-S < packages~ or using your favorite AUR helper -- ~cd ​~/.dotfiles && stow */~ to symlink everything to the right place +- ~stow */~ to symlink everything to the right place + * Theme I use [[https://github.com/catppuccin/catppuccin][catppuccin]] as my theme (the mocha variant). I love the soothing pastel colors. The GTK theme and the Qt5 theme are also configured to be used with supported applications.