From: Josuer08 <josuer08@gmail.com>
Date: Mon, 8 Feb 2021 22:33:57 +0000 (-0500)
Subject: new readme
X-Git-Url: https://git.josue.xyz/?a=commitdiff_plain;h=255b4dd2dbb34511224379004ea71f51a08cdb43;p=dotfiles%2F.git

new readme
---

diff --git a/README.md b/README.md
index 3ca4f9f2..5183a20e 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,50 @@
-# dotfile
-Ok, so, this are my configs and i hope some day i can update this description, but in the meanwhile.....welll
+# Dotfiles
+> Oscar J Rodriguez B
+This is a repo with all of my configurations, it goes from AwesomeWM, TMUX, nvim, vim, nano (yes, nano) and some other programs. I'll try to keep this as updated as possible.
+## What can I use from here?
+
+Well, you are free to take whatever you want, report eny bugs, make pull requests, make forks, or just copy the 100% of my configs, in case you are wondering how to do that then all you need to do is use GNU/stow to place my configs in the correct place in your machine.
+1) `git clone https://github.com/josuer08/dotfiles`
+2) Delete files from your home that you want to replace with mine.
+3) Delete from your copy of the repo the files you dont want from my repo.
+3) `cd dotfiles && stow .`
+4) Enjoy!
+
+## Tree of my home
+.dotfiles/
+├── .config
+│   ├── awesome
+│   ├── bashrc
+│   ├── bashtop
+│   ├── bpytop
+│   ├── coc
+│   ├── GIMP
+│   ├── htop
+│   ├── mpv
+│   ├── nvim
+│   │   ├── autoload
+│   │   ├── plugin
+│   │   └── plugins
+│   ├── obs-studio
+│   ├── pulse
+│   ├── PulseEffects
+│   ├── qutebrowser
+│   │   ├── bookmarks
+│   │   ├── greasemonkey
+│   │   └── qsettings
+│   ├── ranger
+│   ├── slock
+│   ├── systemd
+│   └── wal
+│       ├── colorschemes
+│       │   ├── dark
+│       │   └── light
+│       └── templates
+├── .local
+│   ├── bin
+│   ├── include
+│   └── lib
+├── .nano
+├── scripts
+└── .tmux
+