update readme

This commit is contained in:
Adam 2023-12-31 00:36:06 -05:00
parent d36dfcc213
commit 3287a97d25

View file

@ -26,29 +26,31 @@ If it's not here then you probably don't need it.
- [Oh My Zsh](https://github.com/ohmyzsh/ohmyzsh) - Community enhancements for zsh. Easier than DIY
- [nnn](https://github.com/jarun/nnn) - Lightning fast file manager
- [lf](https://github.com/gokcehan/lf) - File manager like [ranger](https://github.com/ranger/ranger) but faster
- [stpv](https://github.com/Naheel-Azawy/stpv) (via AUR) - For lf previews
- [mosh](https://mosh.org/) - MObile SHell, like ssh but better with a bad connection
### Graphical environment
Business:
- [river](https://github.com/riverwm/river) - Dynamic wayland compositor like DWM written in Zig
- [awesome](https://awesomewm.org/) - Dynamic window manager based on DWM
- [alacritty](https://github.com/alacritty/alacritty) - Fast terminal with GPU acceleration written in Rust
- [playerctl](https://github.com/altdesktop/playerctl) - Handle media keys
- [acpi](https://archlinux.org/packages/community/x86_64/acpi/) - Power/thermal stuff, standby, etc. You want this for a desktop
- [maim](https://github.com/naelstrof/maim) - Screenshot tool, with a script for ease of use
Eye Candy:
- [pywal](https://github.com/dylanaraps/pywal) - Set whole system color scheme from wallpaper colors
- [pywal-discord](https://github.com/FilipLitwora/pywal-discord) - See above
- [wal-telegram](https://github.com/guillaumeboehm/wal-telegram) - See above
- [Pywalfox](https://github.com/Frewacom/pywalfox) - See above
- [nitrogen](https://github.com/l3ib/nitrogen/https://github.com/l3ib/nitrogen) - Wallpaper setter that allows
stretching across multiple screens
- [picom](https://github.com/yshui/picom) - Vsync, shadows, transparency, etc
- [redshift](https://github.com/jonls/redshift) - Shifts screen to red at night to be easier on the eyes
- [unclutter](https://github.com/Airblader/unclutter-xfixes) - Hides the cursor after inactivity
## Install
The install script clones this repo, installs a few dependencies, then copies my configs to `$HOME/.config/` creating a backup
for any config files that already exist. NOTE: Only one backup per file is saved to prevent piling up backups. It's only meant
to catch small oversights and is very verbose.
The install script clones this repo, installs a few dependencies, then copies my configs to `$HOME/.config/`
creating a backup for any config files that already exist. NOTE: Only ONE backup per file is saved to prevent
piling up backups. It's only meant to catch small oversights and is very verbose. In other words, if you run
the installer twice it will overwrite the backup.
Shell tested on Arch, Ubuntu Server 22.04, Fedora 37, it should work just about anywhere.
The install script is only for Arch right now but I plan to include any distro that has these programs in their
repos. Or at least most of them.
### Quick shell (start here):
As your new user in your new user's home directory run: (will overwrite some user files)
@ -57,9 +59,21 @@ As your new user in your new user's home directory run: (will overwrite some use
2. Log out and log back in
## Post Install
1. Neovim will be confused on first start until `:PackerSync` is run
### GUI
For now the setup just installs everything in one shot so you get the GUI whether you need it or not, to use it
just run `startx`
### TODO:
- make installer more granular
- support more distros
### Known issues (aka things to fix and excuses why they aren't):
- Nvim complains about packer
- Awesomewm reload races the bg/color script and may not update. Just reload awesome again manually for now
- Installer can hang at "retrieving packages" - I think this is a pacman/mirror issue. Just kill and restart it,
it'll pick up where it left off
- Xorg may hang on a black screen after a fresh install hiding a sudo password prompt behind it. Ctrl + Alt +
Backspace to kill Xorg and then do something like `sudo echo hey && startx` as a workaround. This may be VM
weirdness, more testing is needed
- Less can block entering sudo password for an update, may also be a weird VM thing, same workaround as above
## Future:
- More granular installer
- Support more distros
- Add color to setup cause why not?