From 7a3bf859ae07d3f0fd1d34e7d496495dd1319386 Mon Sep 17 00:00:00 2001 From: Donovan Glover Date: Mon, 15 Oct 2018 01:44:43 -0400 Subject: [PATCH] Update README Since this repository will now only host my dotfiles, the README has been updated to reflect this change. --- README.md | 48 ++++++++++++++++++++++-------------------------- 1 file changed, 22 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 96c8a62f..866b390f 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,31 @@ -# Arch files +# New Start > Vim is my editor, \*nix is my IDE. -These are my Arch files. I use them with [Arch GNU/Linux](https://www.archlinux.org/). +- Window manager: [bspwm][bspwm] with [`XDG_CURRENT_DESKTOP=KDE`][kde] +- Bar: [polybar][polybar] +- Launcher: [rofi][rofi] +- Icons: [Papirus][papirus] -The `sh` directory contains scripts that handle common installation procedures and other commands required to replicate any part of my setup. +## Usage -The `dots` directory contains all my dotfiles. The scripts in the `sh` directory are in charge of stowing these files as needed. +I manage my dotfiles with [`stow`][stow]. Once you have stow installed, run: -For peace of mind, make sure to place this repository directory somewhere hidden yet easily accessible, ideally as a dot directory in your home path. +```shell +make install +``` -## What's Included +> **Note**: Some of my config files are optimized for HiDPI (between 180 and 192dpi). Adjust those numbers for your display accordingly, or simply don't stow those files. -Arch Linux is great. You can turn it into whatever you want, whether that's a complete desktop environment or a DIY setup with a window manager, adding things piece by piece. +If you want to learn how to make your system work for you, see [What is GNU/Linux?][gnulinux] and [What is free software?][freesw]. -Here's what I recommend: - -- Install **Xfce** if 1) your screen is not HiDPI, 2) you plan to use a lot of GTK applications, and 3) you want a minimal but usable setup for daily tasks. -- Install **Plasma** if 1) you want a desktop environment that supports HiDPI with minimal effort, 2) your computer is new enough that 1GB RAM idle is irrelevant, and 3) you want to take advantage of all the features a desktop environment can offer. -- Install **bspwm** if 1) you are tight on system resources, 2) you're fine with using the terminal and keyboard shortcuts for everything, and 3) you want to work with an advanced tty with better graphics and some GUI support. - -All setups aim to have the following features: - -1. Universal theming -2. Vim-inspired keybindings -3. Easily reproducible - -## Dots - -I manage my dotfiles with `stow`. Different dotfiles are stored in different directories. You can "install" a set of dotfiles with `stow `, e.g. `stow bspwm`. - -My dotfiles are sorted by directory based on 1) whether or not they are DE/WM specific and 2) whether or not they are software specific. - -I try to document many things in both my dotfiles and scripts. If you don't know what something means, try searching on Stack Exchange or the Arch Wiki. When in doubt, just `man software` and `/search` for what you need to know! +[archlinux]: https://www.archlinux.org +[fedora]: https://getfedora.org +[polybar]: https://github.com/jaagr/polybar +[bspwm]: https://github.com/baskerville/bspwm +[rofi]: https://github.com/DaveDavenport/rofi +[papirus]: https://github.com/PapirusDevelopmentTeam/papirus-icon-theme +[gnulinux]: https://www.gnu.org/gnu/linux-and-gnu.html +[freesw]: https://www.gnu.org/philosophy/free-sw.html +[kde]: https://wiki.archlinux.org/index.php/Qt#Configuration_of_Qt5_apps_under_environments_other_than_KDE_Plasma +[stow]: https://www.gnu.org/software/stow/manual/stow.html