28
README.md
Normal file
28
README.md
Normal file
@@ -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.
|
Reference in New Issue
Block a user