aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoreug-vs <eug-vs@keemail.me>2020-12-10 01:22:01 +0300
committereug-vs <eug-vs@keemail.me>2020-12-10 01:22:01 +0300
commit175f45643abea083aed6fd7baeeb8e1ef6ff9037 (patch)
tree4ac2f459b38fd56b154e2825c6632752d3008dcd
parent7b8450be22ed8f0a4adfd028586e4d4f379f7a49 (diff)
downloaddotfiles-175f45643abea083aed6fd7baeeb8e1ef6ff9037.tar.gz
docs: add installation guide
-rw-r--r--.github/README.md19
1 files changed, 18 insertions, 1 deletions
diff --git a/.github/README.md b/.github/README.md
index 7707f78..d323c5b 100644
--- a/.github/README.md
+++ b/.github/README.md
@@ -8,6 +8,23 @@ Author: [eug-vs](https://github.com/eug-vs/)
Documentation: [wiki](../Documents/wiki/index.md)
-## Preview
+## Installation
+1. Checkout into bare git repository:
+ ```sh
+ git clone --bare https://github.com/eug-vs/dotfiles $HOME/.dotfiles.git
+ ```
+2. Setup local alias to simplify your life:
+ ```
+ alias config='git --git-dir=$HOME/.dotfiles.git --work-tree=$HOME'
+ ```
+3. Hide untracked files:
+ ```
+ config config --local status.showUntrackedFiles no
+ ```
+4. Backup you current dotfiles (if any)
+5. Run `git checkout master`
+
+## Screenshots
![project-layout](../Pictures/Porn/project-layout.png)
![neofetch](../Pictures/Porn/neofetch.png)
+