Doors/readme.md

88 lines
3.7 KiB
Markdown
Raw Normal View History

2023-02-03 04:08:44 -05:00
# Doors are sturdier than windows
2023-06-15 16:36:30 -04:00
This is my personal desktop environment that is:
2023-02-03 07:04:28 -05:00
1. Reliable
1. Fast
2023-02-03 07:41:04 -05:00
1. Made from readily available components
2023-02-03 07:04:28 -05:00
1. Simple (see above)
1. Decent looking
2023-02-03 04:08:44 -05:00
2023-02-05 21:42:24 -05:00
I try to use the terminal as much as possible for performance and also so it's the same experience whether
you're at the computer or connected via ssh.
2023-06-15 16:36:30 -04:00
If it's not here then you probably don't need it.
2023-02-03 04:08:44 -05:00
2023-06-15 16:36:30 -04:00
## Most Features
2023-02-05 21:42:24 -05:00
### Shell/Base
- [Yay](https://github.com/Jguer/yay) - Package manager with AUR support (Arch only)
- [rsync](https://rsync.samba.org/) - For my 'push' alias
- [sl](https://github.com/eyJhb/sl) - For when you're too fast
- [btop](https://github.com/aristocratos/btop) - Top++
2023-06-15 16:36:30 -04:00
- [neovim](https://github.com/neovim/neovim) - Edit text blazingly fast (even over ssh)
2023-02-05 21:42:24 -05:00
- [byobu](https://www.byobu.org/) - Comfy multiplexer
2023-02-05 21:52:43 -05:00
- [Oh My Zsh](https://github.com/ohmyzsh/ohmyzsh) - Community enhancements for zsh. Easier than DIY
2023-02-06 06:51:41 -05:00
- [nnn](https://github.com/jarun/nnn) - Lightning fast file manager
2023-02-06 04:10:46 -05:00
- [lf](https://github.com/gokcehan/lf) - File manager like [ranger](https://github.com/ranger/ranger) but faster
2023-12-31 00:36:06 -05:00
- [mosh](https://mosh.org/) - MObile SHell, like ssh but better with a bad connection
2024-01-01 04:33:22 -05:00
2023-02-05 21:42:24 -05:00
### Graphical environment
Business:
2023-06-15 16:36:30 -04:00
2023-12-31 00:36:06 -05:00
- [awesome](https://awesomewm.org/) - Dynamic window manager based on DWM
2023-06-19 20:31:37 -04:00
- [alacritty](https://github.com/alacritty/alacritty) - Fast terminal with GPU acceleration written in Rust
2023-12-31 00:36:06 -05:00
- [maim](https://github.com/naelstrof/maim) - Screenshot tool, with a script for ease of use
2023-02-05 21:42:24 -05:00
Eye Candy:
- [pywal](https://github.com/dylanaraps/pywal) - Set whole system color scheme from wallpaper colors
2023-12-31 00:36:06 -05:00
- [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
2023-02-05 21:42:24 -05:00
2023-02-03 04:08:44 -05:00
## Install
2023-12-31 00:36:06 -05:00
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
2024-01-01 04:33:22 -05:00
the installer twice IT WILL OVERWRITE THE BACKUP!
2023-06-15 16:36:30 -04:00
2023-12-31 00:36:06 -05:00
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.
2023-02-03 07:04:28 -05:00
2023-02-05 21:42:24 -05:00
### Quick shell (start here):
2024-01-01 04:33:22 -05:00
Note: back up your home directory or create a new user or you aren't allowed to complain about anything being
overwritten
2023-02-03 04:08:44 -05:00
2023-06-18 19:13:52 -04:00
1. ```curl https://doors.doordesk.net/setup | bash```
2023-02-03 04:08:44 -05:00
2. Log out and log back in
2023-12-31 00:36:06 -05:00
### GUI
2024-01-01 04:33:22 -05:00
- 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` or start awesome from your display manager if you have one.
- The mod keys are Super, Menu, and Meta
- Once in awesome press Mod + F1 for a quick reference of all keybinds
2023-12-31 00:36:06 -05:00
2024-01-01 02:15:49 -05:00
## Post Install
### Neovim
- Run `:PackerSync` on first run, `:Mason` to install language servers, `:TSUpdate` after installing language
servers to update treesitter
2023-12-31 00:47:28 -05:00
## Known issues (aka things to fix and excuses why they aren't):
2023-12-31 00:36:06 -05:00
- 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
2024-01-01 04:33:22 -05:00
- lsp-zero (nvim plugin) changed some things and needs to be reconfigured
2023-12-31 00:36:06 -05:00
## Future:
2024-01-01 04:33:22 -05:00
- Move stuff from xinitrc/xprofile to awesome rc to be less intrusive on existing systems
2023-12-31 00:36:06 -05:00
- More granular installer
- Support more distros
- Add color to setup cause why not?