Initial commit
This commit is contained in:
57
README.md
Normal file
57
README.md
Normal file
@@ -0,0 +1,57 @@
|
||||
# dotfiles
|
||||
|
||||
My terminal setup as a one-liner. Works on Debian/Ubuntu, Fedora/RHEL, Arch, and macOS.
|
||||
|
||||
## What it gives you
|
||||
|
||||
- **zsh** as the login shell
|
||||
- **oh-my-zsh** with plugins: `git kubectl zsh-autosuggestions sudo copypath copyfile dirhistory docker docker-compose nvm`
|
||||
- **powerlevel10k** prompt with my exact `.p10k.zsh` config
|
||||
- **atuin** for searchable, sync-able shell history (works in bash too)
|
||||
|
||||
## Install
|
||||
|
||||
```sh
|
||||
git clone https://github.com/<you>/dotfiles ~/dotfiles
|
||||
cd ~/dotfiles && ./install.sh
|
||||
```
|
||||
|
||||
Or, if you trust me:
|
||||
|
||||
```sh
|
||||
curl -fsSL https://raw.githubusercontent.com/<you>/dotfiles/main/install.sh | bash
|
||||
```
|
||||
|
||||
The script is idempotent — re-run it any time to pull updates.
|
||||
|
||||
## Machine-specific config
|
||||
|
||||
Anything personal (API keys, conda/nvm init, work-laptop paths) goes in
|
||||
`~/.zshrc.local`. The shipped `.zshrc` sources it if present, and it's not
|
||||
tracked here.
|
||||
|
||||
Example `~/.zshrc.local`:
|
||||
|
||||
```sh
|
||||
# Per-machine overrides
|
||||
export EDITOR=nvim
|
||||
export GITHUB_TOKEN=...
|
||||
|
||||
# nvm (if you installed it)
|
||||
export NVM_DIR="$HOME/.nvm"
|
||||
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
|
||||
```
|
||||
|
||||
## Fonts
|
||||
|
||||
Powerlevel10k looks broken without a Nerd Font. Easiest:
|
||||
<https://github.com/romkatv/powerlevel10k#meslo-nerd-font-patched-for-powerlevel10k>
|
||||
|
||||
Install the four `MesloLGS NF *.ttf` files, then set your terminal font to `MesloLGS NF`.
|
||||
|
||||
## Uninstall
|
||||
|
||||
```sh
|
||||
rm ~/.zshrc ~/.p10k.zsh
|
||||
mv ~/.zshrc.backup.<timestamp> ~/.zshrc # if you want the old one back
|
||||
```
|
||||
Reference in New Issue
Block a user