From 2de97e421c3756d35030d7ccbb2f7a1e4e7d209a Mon Sep 17 00:00:00 2001 From: Marvin Elsen Date: Mon, 2 Sep 2024 17:44:42 +0200 Subject: [PATCH] Add installation instructions and description --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 1c3a3f2..d72a07c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,20 @@ # Dotfiles +This repository contains my personal configuration managed by [GNU Stow](https://www.gnu.org/software/stow/) for the following applications: + +- [Neovim](https://neovim.io) +- [Wezterm](https://wezfurlong.org/wezterm/) +- [Git](https://git-scm.com) + ## Install +To apply a configuration execute the following steps: + ```sh +# Clone git repository +git clone git@gitea.marvinelsen.com:marvinelsen/dotfiles.git +cd dotfiles + +# Apply Neovim configuration stow --verbose --restow --target ~ nvim ```