extern/nix-config
1
0
Fork 1
mirror of https://github.com/donovanglover/nix-config.git synced 2025-01-23 14:18:37 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source 
Since this repository has diverged once again in attempt to make
something maintainable, the README has been re-written once more.

It would be amazing if this turns out to be the final iteration of
things, and all that's left is stripping out the unnecessary.
This commit is contained in:
Donovan Glover 2018-09-01 01:04:33 -04:00
parent 547032a285
commit 4ab89ef96b
No known key found for this signature in database
GPG Key ID: EA7408A77AE1BE65
1 changed files with 27 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -1,18 +1,35 @@
# Dotfiles
# Arch files
> Vim is my editor, \*nix is my IDE.
![Screenshot](etc/preview.jpg?raw=true)
![Screenshot](etc/preview2.jpg?raw=true)
These are my Arch files. I use them with [Arch GNU/Linux](https://www.archlinux.org/).
These are my dotfiles. I use them with [Arch GNU/Linux](https://www.archlinux.org/).
The `sh` directory contains scripts that handle common installation procedures and other commands required to replicate any part of my setup.
My dotfiles aim to be simple, straight-forward, and to the point. If you want to know how something works, just `man software` and `/search` for what you need to know!
The `dots` directory contains all my dotfiles. The scripts in the `sh` directory are in charge of stowing these files as needed.
Key features:
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.
- Universal theming
- Vim-inspired keybinds
- Easy to reproduce
## What's Included
My dotfiles are managed with stow. Different dotfiles are stored in different directories. You can "install" a set of dotfiles by simply running `stow <dir>`, e.g. `stow bspwm`.
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.
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 <dir>`, 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!