Mes dotfiles, qui regroupent tout ce dont j'ai besoin pour utiliser ma machine, à savoir mes fichiers de config et mes scripts
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

111 lines
2.6 KiB

# Swy7ch' personnal dotfiles
**Hello, world!** This is my dotfiles directory.
Feel free to use it at your convenience :)
I'm David. I'm a Computer Science student from France, and a *huge* fan of
Linux, especially Arch. I also like making things simple and neat, and this is
the sole purpose of this directory: keeping my needed files in a safe place,
so that I can reinstall Arch easily without much tinkering.
## Installation
Clone the repo :
```sh
$ git clone --bare --recurse-submodules <repo_url> ~/.dotfiles.git
```
then after setting an alias like
```sh
$ alias dotfiles='/usr/bin/git --git-dir=$HOME/.dotfiles.git/ --work-tree=$HOME'
```
just run
```sh
$ dotfiles checkout
```
Note: the repo already provides an alias file (`~/.config/aliasrc`) which sets
this alias up. For this alias to work, you need to source
`~/.config/zsh/.zprofile` before.
## ~/
Contains the files that I haven't been able to put in `~/.config`.
## Programs whose config files can be found in ~/.config/
- `dunst`
- `git`
- `htop`
- `mpd`
- `ncmpcpp`
- `neovim v0.5+`
- `neomutt`
- `pacman` **(hooks only)**
- `paru`
- `redshift`
- `sxhkd`
- `zathura`
- `zsh`
- `old`
- `fish-shell`
- `i3-gaps`
- `neofetch`
- `neovim v0.4.4`
- `polybar`
- `termite`
- `ranger`
- `vim`
### ~/.config/root/
Where I keep the files I have to copy into the `/` folder. It is not called in
`arch_setup` as it is quite sensible.
## ~/.local/bin
My personnal scripts that I use to make things easier. Some of them are used by
programs I use, like my WM for instance.
## Window manager and terminal emulator
I currently use [suckless](https://suckless.org/)' programs, i.e. `dmenu`
(binary launcher), `dwm` (window manager) and `st` (terminal emulator),
so my files are set accordingly. My statusbar is set through
[dwmblocks](https://github.com/torrinfail/dwmblocks).
All my forks are available on this account!
## Submodules
Since commit `93440b9`, those forks are provided as submodules, provided in
`~/.local/src`. To retrieve them, run
```sh
$ git submodule init
...
$ git module update
```
## GPLv3 License
This repo is, since commit `a7ee60f`, licensed under the GPLv3. Depending on
your situation, it might not change anything. This is what is required:
0. For your personnal usage, do what you want.
1. If you ever wanted to re-publish it, you can.
2. If you ever want to modify it, you can.
3. If you want to melt any part of this repo into your project, this
project **must** be licensed under the GPLv3.
More informations:
* The GNU webpage regarding the license:
https://www.gnu.org/licenses/gpl-3.0.en.html
* The Choose A License page about GPLv3:
https://choosealicense.com/licenses/gpl-3.0/