dotfiles/README.md

67 lines
2.6 KiB
Markdown
Raw Normal View History

2023-12-23 20:13:47 -07:00
Hit the ground flying with dotfiles for Unix-like systems including MacOS. These
contain all sorts of goodies for bash, vim, shell scripts, unix notes, and much
more!
# Installation
```bash
git clone --depth=1 'ssh://git@codeberg.org:22/akemi/dotfiles.git' dotfiles
cd dotfiles
bash ./install.sh --help
2023-12-23 20:13:47 -07:00
```
`install.sh status` tells you which files can be linked and which ones are
already on your system. Move the ones on your system out of the way before
continuing
2023-12-23 20:13:47 -07:00
```bash
bash install.sh install
bash install_packages.sh install
2023-12-23 20:13:47 -07:00
```
If you're running ArchLinux or EndeavourOS, `post_install.sh` will help guide
you through additional installation steps you can take. See
`./notes/futher_installation/` for a description of these steps
2023-12-23 20:13:47 -07:00
## Support
2023-12-23 20:13:47 -07:00
Official support is for the latest version of bash and EndeavourOS only. The
MacOS dotfiles were working on Catalina (10.15) and likely mostly work on newer
versions as well
2023-12-23 20:13:47 -07:00
2023-12-23 20:13:59 -07:00
As of writing, [EndeavourOS](
https://endeavouros.com/) is on Linux **6.0.8** and bash is version **5.1.16**
2023-12-23 20:13:47 -07:00
2023-12-23 20:13:59 -07:00
For Linux, these dotfiles setup [Sway](https://github.com/swaywm/sway) on
[Wayland](https://wayland.freedesktop.org/), a completely different display
server from Xorg. [I3](https://i3wm.org/) is similar to Sway for Xorg
I'm increasingly migrating my scripts from bash to python. Many require at least
**python version 3.10** (match statements) to run properly. EndeavourOS and
other Arch-based systems keep their python up to date, make sure you do too
2023-12-23 20:13:47 -07:00
# Keybinding
2023-12-23 20:13:47 -07:00
Generally keybindings follow this scheme for `skhd`/`xremap`, bash, and vim's
insert mode. They roughly resemble Emac's default. Outliers are bolded. These
are written assuming Ctrl is mapped to CapsLock
When possible selecting is preferred to actually deleting the text
| Type | Start of line | Back word | Back character | Forward character | Forward word | End of line |
| ---- | ------------- | --------- | -------------- | ----------------- | ------------ | ----------- |
| Movement | `^a` | **`^b`** | **`^j`** | `^f` | **`^w`** | `^e` |
| Deletion | | **`^u`** | `^h` | `^d` | | `^k` |
2023-12-23 20:13:47 -07:00
Window managers are bound to the Super/Command/Logo key. This is the key
adjacent to the spacebar
2023-12-23 20:13:47 -07:00
# Light and Dark Mode
2023-12-23 20:13:47 -07:00
Alacritty, tmux, vim, vifm, vimiv are all synchronously colored through
`bin/colo.sh`. This script supports multiple color schemes and makes it easy to
add new ones.
In running instances of vim and vifm, use `:Light` or `:Dark` to update their
color scheme to match Alacritty. New instances are automatically updated