added readme

This commit is contained in:
Nicolai Van der Storm 2024-11-22 11:53:34 +01:00
parent db9962474d
commit a698edb3b0

42
README.md Normal file
View File

@ -0,0 +1,42 @@
# My dotfiles
This directory contains the dotfiles for my system
## Requirements
Ensure you have the following installed on your system
### Git
```
pacman -S git
```
### Stow
```
pacman -S stow
```
## Installation
First, check out the dotfiles repo in your $HOME directory using git
```
$ git clone ssh://git@git.nvds.be:2222/NicolaiVdS/Dotfiles.git
```
or
```
$ git clone https://git.nvds.be/NicolaiVdS/Dotfiles.git
```
```
$ cd dotfiles
```
then use GNU stow to create symlinks
```
$ stow .
```