From ebc2b32f9db956f8e962a56044c9b6bd68b112ba Mon Sep 17 00:00:00 2001 From: Aaditya Dhruv Date: Sun, 10 Sep 2023 13:55:30 -0500 Subject: Update README and include CONFIGURATION.md CONFIGURATION.md describes how to configure the playbook and what each variable does --- README.md | 34 ++++++++++------------------------ 1 file changed, 10 insertions(+), 24 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 1ef522a..896ce8d 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,18 @@ -# bspwm-dotfiles -My BSPWM + Arch/Void setup config and dotfiles +# Dotfiles +This repository is used to setup my Fedora Workstation. It consists of various Ansible playbooks that automate a +large chunk of setting up tools, configuartion files and system packages. -This is the setup I use when running BSPWM on Arch/Void. +While I use GNOME on my workstation, this playbook allows installation of either BSPWM (XOrg) or Hyprland (Wayland). +Those flags can be setup in `config.yaml`. -The auto-setup should work to setup the config files. -Zsh setup works, but you need to run it twice since it takes you to the ZSH prompt. +All configuration should be done through `config.yaml`. The repo does let you install a lot of the packages by +`groups` -Currently the script to install the packages are using pacman but to run it on Void (or any other distro) just change the syntax. +To understand how to configure the installation, refer to [`CONFIGURATION.md`](./CONFIGURATION.md) -For Void: -pacman -S ---> xbps-install +This is how the setup looks on Fedora with Hyprland as the TWM. -xorg-server --> xorg - - -On Fedora (Current): - -![alt fedora](images/fedora-wayland.png "Dots on Fedora") - -On Arch: - -![alt arch](images/arch.png "Dots on Arch") - - - -On Void: - -![alt void](images/void.png "Dots on Void") +![alt fedora](res/fedora-wayland.png "Hyprland on Fedora") -- cgit