aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 20d37a9871123682c6ea70d0f492247ded07ddc6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
```
      ██            ██     ████ ██  ██
     ░██           ░██    ░██░ ░░  ░██
     ░██  ██████  ██████ ██████ ██ ░██  █████   ██████
  ██████ ██░░░░██░░░██░ ░░░██░ ░██ ░██ ██░░░██ ██░░░░
 ██░░░██░██   ░██  ░██    ░██  ░██ ░██░███████░░█████
░██  ░██░██   ░██  ░██    ░██  ░██ ░██░██░░░░  ░░░░░██
░░██████░░██████   ░░██   ░██  ░██ ███░░██████ ██████
 ░░░░░░  ░░░░░░     ░░    ░░   ░░ ░░░  ░░░░░░ ░░░░░░  

  ▓▓▓▓▓▓▓▓▓▓
 ░▓ about  ▓ custom linux config files
 ░▓ author ▓ neodarz <neodarz@neodarz.net>
 ░▓ code   ▓ https://git.neodarz.net/neodarz/conf/dotfiles_dotdrop.git
 ░▓ thanks ▓ Based on a work of xero <x@xero.nu>
 ░▓▓▓▓▓▓▓▓▓▓
 ░░░░░░░░░░

 aria2          > aria2 deamon
 alacritty      > terminal config
 cheat          > cheatsheets management
 figlet         > fonts for figlet
 git            > global git config
 gnupg          > gnupg config
 i3             > i3 window manager config
 i3pystatus     > i3 bar window manager replacement config
 khal           > calendar config
 mutt           > mutt config
 msmtp          > smtp client config
 notmuch        > notmuch mail system config
 offlineimap    > imap client config
 nvim           > neovim config
 scripts        > misc scripts
 ssh            > ssh config
 systemd        > user services for differents application
 taskwarrior    > simple task manager config
 vdirsyncer     > sync mail config mail
 xinitrc        > xinitrc config
 Xresources     > theme config
 zhs            > zhs config
```
# Managing

This dotfiles configuration use [dotdrop](https://github.com/deadc0de6/dotdrop) to manage the files.

# Installing

Nothing to do for dotdrop, it's already installed. :)

However for install dotfiles you need to do it yourself. :p

`./dotdrop.sh install`

For install system dotfile you need to use the root user and the
`system-config.yaml` config file.

`sudo ./dotdrop.sh install --cfg=system-config.yaml`

This install the dotfiles for the profiles listed in `config.yaml` file.
Check the documentation for more info about profiles and how to use it.

You also need to install all softawre who use this dotfile, for that you
just to use `install.sh`. It's install softwares *and* dotfiles.

The `install.sh` script is decouped in 4 parts:
- common software installation
- software's dotfile (It' can be a repition of previous part)
- dotfiles installation
- post dotfiles installation for some software like vim who need to install
plugins.

# Note

Please not that my cheatsheets can be wrong sometimes!