Add installation section and update setup.sh accordingly
This commit is contained in:
parent
9de3d96374
commit
c6a83084e5
11
.config/setup.sh
Normal file → Executable file
11
.config/setup.sh
Normal file → Executable file
@ -1,10 +1,17 @@
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
|
||||||
|
###################### Specific to Arch based distributions ######################
|
||||||
## Install needed packages
|
## Install needed packages
|
||||||
# WM : bspwm sxhkd xorg-xinit xorg-server xorg-randr xterm alacritty
|
# WM : bspwm sxhkd xorg-xinit xorg-server xorg-randr xterm alacritty
|
||||||
|
# Cosmetic : feh
|
||||||
|
# Fonts : nerd-fonts-meslo
|
||||||
# Dev env : git tmux
|
# Dev env : git tmux
|
||||||
# Yay dep : base-devel
|
# 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
|
## Install yay
|
||||||
git clone https://aur.archlinux.org/yay.git /tmp/yay
|
git clone https://aur.archlinux.org/yay.git /tmp/yay
|
||||||
@ -14,6 +21,8 @@ makepkg -si
|
|||||||
## Install AUR packages
|
## Install AUR packages
|
||||||
yay -S polybar pulseaudio-control eww-git
|
yay -S polybar pulseaudio-control eww-git
|
||||||
|
|
||||||
|
###################### Distribution agnostic ######################
|
||||||
|
|
||||||
## Install vim-plug
|
## Install vim-plug
|
||||||
sh -c 'curl -fLo "${XDG_DATA_HOME:-$HOME/.local/share}"/nvim/site/autoload/plug.vim --create-dirs \
|
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'
|
https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim'
|
||||||
|
23
README.md
23
README.md
@ -38,9 +38,30 @@ Still have a doubt about what you want from here ? You might want to take a look
|
|||||||
|
|
||||||
<a id="install"></a>
|
<a id="install"></a>
|
||||||
## Installation
|
## Installation
|
||||||
|
### Requirements
|
||||||
|
Before doing anything, you will need to have `git` installed.<br>
|
||||||
|
|
||||||
/!\ To be written
|
#### Arch
|
||||||
|
For Arch Linux users, you can simply execute the `.config/setup.sh` script and get going.
|
||||||
|
|
||||||
|
#### 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>
|
<a id="keybinds"></a>
|
||||||
## Keybinds
|
## Keybinds
|
||||||
These are the most used and basic keybinds. You might want to read through `.config/i3/config` to find more keybindings and add your own.
|
These are the most used and basic keybinds. You might want to read through `.config/i3/config` to find more keybindings and add your own.
|
||||||
|
Loading…
Reference in New Issue
Block a user