docs(readme): create README.md
This commit is contained in:
27
README.md
Normal file
27
README.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# Dotfiles
|
||||
|
||||
This repository contains my dotfiles for various tools. Most of it are my very own decisions. I got some inspiration from [typecraft](https://www.youtube.com/@typecraft_dev). I can really recommend his videos.
|
||||
|
||||
## Installation
|
||||
|
||||
### 1. Clone this repository
|
||||
|
||||
Run the following command to clone this repository.
|
||||
|
||||
```bash
|
||||
git clone https://github.com/antistereov/dotfiles
|
||||
```
|
||||
|
||||
### 1. Install required tools
|
||||
|
||||
If you want to use any of the tools listed in this repository, you should check out the READMEs in the corresponding sub-directory.
|
||||
|
||||
### 2. Use `stow` to create syslinks
|
||||
|
||||
Go to the root of this repository and run:
|
||||
|
||||
```bash
|
||||
stow .
|
||||
```
|
||||
|
||||
> **Note:** Make sure to run this command every time you update this repository.
|
||||
Reference in New Issue
Block a user