Revamp README(s).

This commit is contained in:
the_4n0nym0u53 2021-12-30 15:38:46 +01:00
parent 5dabf914c0
commit 35643435c5
No known key found for this signature in database
GPG key ID: 35EE09F5481049BB
6 changed files with 34 additions and 28 deletions

View file

@ -4,7 +4,7 @@ This is a collection of some of my dotfiles for my Artix Linux system.
![Screenshot](./.img/screenshot.png) ![Screenshot](./.img/screenshot.png)
You can install these dotfiles by cloning this repository and executing `install.sh`. You can install these dotfiles by cloning this repository and executing `install.sh`:
```bash ```bash
$ git clone https://github.com/theanonymousexyz/dotfiles.git $ git clone https://github.com/theanonymousexyz/dotfiles.git
@ -13,32 +13,15 @@ $ chmod +x install.sh
$ ./install.sh $ ./install.sh
``` ```
This configuration depends on the following packages\*: Note that I use `doas` instead of `sudo`. If you prefer `sudo`, then change all instances of `doas` to `sudo`, or simply create a symlink `doas` pointing to `sudo`:
- `alacritty` ```bash
- `artix-backgrounds` sudo ln -s $(which sudo) /usr/bin/doas
- `doas`\*\* ```
- `git`
- `grimshot`
- `ivpn` (daemon + CLI)
- `mako`
- `neovim`
- `pavucontrol`
- `pipewire`
- `playerctl`
- `python`
- `stow`
- `sway`
- `swaylock-effects`
- `sway-launcher-desktop`
- `waybar`
- `wireplumber`
- `wl-clipboard`
- `zsh`
\* Feel free to change anything to your liking.
\*\* If you prefer `sudo`, then change all instances of `doas` to `sudo`.
Also, you need to make `doas`/`sudo` rules that allow you to execute `ivpn-service`, `poweroff`, `reboot` and `pkill ivpn-service` without a password, otherwise the keybindings and scripts for those won't work.
**Notes:**
- You need to make `doas`/`sudo` rules that allow you to execute, `poweroff` and `reboot` (and additionally `ivpn-service` and `pkill "^ivpn-service$"` if you use IVPN) without a password, otherwise the keybindings and scripts for those won't work.
- The install script requires GNU Stow to work.
- Make sure to thoroughly examine these dotfiles and change them to your needs before using them.
- See the READMEs for some of the packages here for special notes.
- Optionally fork this repository to make maintenance easier.

5
nvim/README.md Normal file
View file

@ -0,0 +1,5 @@
# Neovim config
This Neovim config requires [vim-plug](https://github.com/junegunn/vim-plug) for plugins.
To install the plugins from the config file, first install vim-plug, and then run `PlugInstall` inside Neovim.

5
scripts/README.md Normal file
View file

@ -0,0 +1,5 @@
# Scripts
For these custom scripts to work, you need to add `$HOME/.local/bin` to your `PATH`.
If you use my Zsh config, this is already taken care of.

7
sway/README.md Normal file
View file

@ -0,0 +1,7 @@
# Sway config
My Sway config currently uses and/or depends on the following packages:
- `artix-backgrounds` for the wallpaper
- `grimshot` for screenshotting
- `sway-launcher-desktop` for launching applications

3
swaylock/README.md Normal file
View file

@ -0,0 +1,3 @@
# Swaylock config
This config is in fact for `swaylock-effects`, which you can get from the AUR.

3
waybar/README.md Normal file
View file

@ -0,0 +1,3 @@
# Waybar config
This is a beautifully styled config for Waybar, featuring a solarized dark coloscheme and a custom module for showing IVPN connection status (thus requires IVPN client).