From 7b532cc3139160cebf2ca81e7018c9f747a21688 Mon Sep 17 00:00:00 2001 From: Noah Knegt Date: Tue, 27 Feb 2024 16:02:45 +0100 Subject: [PATCH] docs: Add readme Signed-off-by: Noah Knegt --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..8707cc1 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# Dotfiles repository + +This repo contains dotfiles that are used to configure applications on the system. + +## Requirements + +In order to properly use this repo the following applications are needed: + +- Git +- Stow + +## Usage + +First clone the repository to any location on the system with the following command. +This assumes that ssh is already properly configured on your system. + +```bash +git clone ssh://git@git.noahknegt.com/noah.knegt/dotfiles.git +``` + +Then run stow in the cloned directory. + +```bash +stow -t ~ . +``` + +This will create symlinks to the files in the cloned repo in the home directory. +If this command fails for any reason try `stow` with the `--adopt` option.