Merge branch 'master' of https://github.com/TanguyHerbron/dotfiles

.config/polybar/user_modules.ini

@@ -316,7 +316,7 @@ type = custom/script
 tail = true
 label-foreground = ${color.white}
 
-exec = pulseaudio-control --icons-volume " , " --icon-muted " " --sink-nicknames-from "device.description" --sink-nickname "bluez_sink.E8_07_BF_DC_F3_6F.a2dp_sink: Aukey earpods"  --sink-nickname "alsa_output.pci-0000_00_1f.3.analog-stereo:蓼 Speakers" listen 
+exec = pulseaudio-control --icons-volume " , " --icon-muted " " --sink-nicknames-from "device.description" --sink-nickname "bluez_sink.E9_07_BF_DC_F3_6F.a2dp_sink: Aukey earpods" --sink-nickname "alsa_output.usb-Corsair_Corsair_VOID_PRO_Wireless_Gaming_Headset-00.analog-stereo: Void pro"  --sink-nickname "alsa_output.pci-0000_00_1f.3.analog-stereo:蓼 Speakers" listen 
 click-right = exec pavucontrol &
 click-left = pulseaudio-control togmute
 click-middle = pulseaudio-control next-sink

.config/setup.sh

@@ -1,10 +1,17 @@
 #!/bin/bash
 
+###################### Specific to Arch based distributions ######################
 ## Install needed packages
 # WM : bspwm sxhkd xorg-xinit xorg-server xorg-randr xterm alacritty
+# Cosmetic : feh
+# Fonts : nerd-fonts-meslo
 # Dev env : git tmux
 # Yay dep : base-devel
-sudo pacman -S bspwm sxhkd xorg-xinit xorg-server xorg-xrandr xterm alacritty git tmux base-devel 
+sudo pacman -S bspwm sxhkd xorg-xinit xorg-server xorg-xrandr xterm alacritty \
+    feh \
+    nerd-fonts-meslo \
+    git tmux \
+    base-devel 
 
 ## Install yay
 git clone https://aur.archlinux.org/yay.git /tmp/yay
@@ -14,6 +21,8 @@ makepkg -si
 ## Install AUR packages
 yay -S polybar pulseaudio-control eww-git
 
+###################### Distribution agnostic ######################
+
 ## Install vim-plug
 sh -c 'curl -fLo "${XDG_DATA_HOME:-$HOME/.local/share}"/nvim/site/autoload/plug.vim --create-dirs \
        https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim'

README.md

@@ -45,14 +45,32 @@ Still have a doubt about what you want from here ? You might want to take a look
 - [w3m](http://w3m.sourceforge.net/)
 - [bitwarden-cli](https://github.com/bitwarden/cli)
 - [bitwarden-rofi](https://github.com/mattydebie/bitwarden-rofi)
+- [git](https://git-scm.com/)
 
-### Cloning the repository
 
-/!\ To be written
+### Per distro instructions
 
-### Configuration
+#### Arch
+For Arch Linux users, you can simply execute the `.config/setup.sh` script and get going.
 
-/!\ To be written
+#### Other distributions
+I recommend taking a look at the `.config/setup.sh` script and comment out everything special to Arch (`pacman` and `yay` section).
+Then, I advise to install all packages from source if you run into issues, since everything is meant to be used with latest versions (looking at you `neovim`).
+### Dotfiles installation
+- Clone the repository
+```
+git clone --bare https://github.com/TanguyHerbron/dotfiles.git $HOME/.dotfiles
+```
+- Define a one time alias
+```
+alias dotfiles='/usr/bin/git --git-dir=$HOME/.dotfiles/ --work-tree=$HOME'
+```
+- Checkout the content from the git repository to your `$HOME`
+```
+dotfiles checkout
+```
+
+From this point on, if you have `zsh` installed, the `dotfiles` alias will be added to your shell by default. Otherwise, you might want to add it yourself or instasll `zsh`.
 
 <a id="keybinds"></a>
 ## Keybinds