Switch to a yaml based install

Remove unneeded function

Author: erichlf

README.md

@@ -1,141 +1,104 @@
-# 🚀 Dotfiles
+# Dotfiles
 
-A comprehensive collection of configuration files for a modern development environment, featuring a highly customized LazyVim setup, zsh configuration, and automated installation scripts.
+A curated set of dotfiles and scripts to bootstrap a comfortable, modern dev environment. It includes shell configuration (zsh), a Lua-based Neovim setup, and a small set of helper scripts to install prerequisites and symlink everything into place.
 
-## ✨ What's Included
-
-### Core Configurations
-- **Neovim**: Heavily customized LazyVim configuration with enhanced keybindings and additional plugins
-- **Zsh**: Modern shell setup using zgenom and oh-my-zsh
-- **Git**: Optimized git configuration and aliases
-- **Terminal**: Various terminal emulator configurations
+---
 
-### Key Features
-- 📦 **Automated Installation**: One-command setup for new systems
-- 🔗 **GNU Stow Integration**: Clean symlink management
-- 🎯 **LazyVim Enhancement**: Custom keybindings and plugin configurations
-- 🔧 **DevContainer Support**: Includes `nvim-devcontainer-cli` plugin
-- 🌟 **Cross-Platform**: Support for multiple operating systems
+## What’s inside
 
-## 📁 Repository Structure
+- **`home/`** — Files intended to live directly under `$HOME` (e.g., shell RCs).
+- **`config/`** — Files for `$HOME/.config` (e.g., `nvim/` for the Neovim config written in Lua).
+- **`scripts/`** — Helper/installer scripts used during setup.
+- **`install.sh`** — One-shot installer that orchestrates the setup.
+- Extras:
+  - `guake.conf` (terminal), `vimium.json` (browser Vim keybinds), `resticprofile.toml`, `sanoid.conf` (backup/snapshots).
 
-```
-dotfiles/
-├── home/           # Files that go directly in $HOME
-├── config/         # Files that go in $HOME/.config
-│   └── nvim/       # LazyVim configuration
-│       └── lua/user/   # Custom user configurations
-├── scripts/        # Installation and utility scripts
-│   ├── main.sh     # Interactive installation menu
-│   └── utils.sh    # Shared functions and utilities
-├── private/        # Private configurations (not tracked)
-└── install.sh      # Main installation script
-```
+> The repository is primarily **Lua** and **Shell**, reflecting the Neovim config plus installer scripts.
 
-## 🚀 Quick Start
+---
 
-### Full Installation
+## Quick start
 
-Clone the repository and run the installation script:
+> **Requirements:** `git` and a POSIX-like environment (Linux/macOS). The installer will try to install anything else it needs (e.g., zsh, Neovim) depending on your system.
 
 ```bash
+# clone
 git clone https://github.com/erichlf/dotfiles.git ~/.dotfiles
 cd ~/.dotfiles
-./install.sh
-```
 
-### Dotfiles Only
-
-If you only want to install the configuration files without additional software:
-
-```bash
-./scripts/main.sh
-# Select "Create symbolic links" from the menu
+# run the installer
+./install.sh
 ```
 
-## ⚙️ Installation Process
-
-The installation system automatically:
-
-1. **Detects your operating system** and selects appropriate installation scripts
-2. **Installs required dependencies** based on your system
-3. **Creates symbolic links** using GNU Stow for clean file management
-4. **Configures shell environment** with zsh and custom themes
-
-### Environment Variables
-
-The installation scripts use these environment variables:
+What the installer typically does:
 
-- `DOTFILES_DIR`: Path to the dotfiles repository
-- `SYSTEM`: System identifier (auto-detected, used for debugging)
+1. Detects your OS/distro.
+2. Installs or updates core tools (zsh, neovim, etc.) as needed.
+3. Creates symlinks from the repo to your `$HOME` and `$HOME/.config`.
+4. Optionally applies terminal/editor/browser extras.
 
-## 🎯 LazyVim Configuration
+> Prefer to do things manually? See **Manual linking** below.
 
-The crown jewel of this repository is the highly customized LazyVim configuration located in `config/nvim/`. 
-
-### Key Improvements
-- **Enhanced Keybindings**: More intuitive and efficient key mappings
-- **Additional Plugins**: Including `nvim-devcontainer-cli` for container development
-- **Custom User Configurations**: Located in `config/nvim/lua/user/`
-- **Modular Structure**: Easy to understand and modify
-
-### Notable Plugins
-- DevContainer CLI integration
-- Enhanced file navigation
-- Improved LSP configurations
-- Custom statusline and themes
+---
 
-## 🛠️ Customization
+## Manual linking (advanced)
 
-### Adding New Configurations
+If you’d rather link files yourself:
 
-1. **For $HOME files**: Add to `home/` directory
-2. **For $HOME/.config files**: Add to `config/` directory
-3. **Run stow**: `stow home config` to create symlinks
+1. Copy or symlink anything under `home/` into `$HOME`.
+2. Copy or symlink anything under `config/` into `$HOME/.config`.
+3. Launch a new shell to pick up zsh config; start `nvim` to let plugins finish bootstrapping.
 
-### Modifying LazyVim
+> Tip: If you use GNU Stow, you can mirror `home/` and `config/` into place cleanly (not required by the repo, but convenient).
 
-The most important customization files are in `config/nvim/lua/user/`. The naming convention is self-explanatory:
+---
 
-- `keymaps.lua` - Custom keybindings
-- `options.lua` - Neovim options
-- `plugins/` - Additional plugin configurations
+## Updating
 
-## 📋 Requirements
+```bash
+cd ~/.dotfiles
+git pull
+# re-run the installer if you want it to reconcile changes
+./install.sh
+```
 
-- **Git**: For cloning the repository
-- **GNU Stow**: For symlink management
-- **Zsh**: Modern shell (auto-installed if not present)
-- **Neovim**: Recent version for LazyVim compatibility
+---
 
-## 🔧 Troubleshooting
+## Uninstalling / reverting
 
-### Common Issues
+Remove symlinks you created and/or restore your previous dotfiles backup. If you used Stow, `stow -D <package>` will reverse those links. If you used the one-shot installer, re-run it to switch features off, or remove the linked files in `$HOME`/`$HOME/.config` that point into `~/.dotfiles`.
 
-1. **Stow conflicts**: Remove existing dotfiles before running installation
-2. **Missing dependencies**: Run `./scripts/main.sh` and select dependency installation
-3. **Permission issues**: Ensure you have write access to your home directory
+---
 
-### Getting Help
+## Repository layout
 
-If you encounter issues:
+```
+dotfiles/
+├─ home/             # items that should live directly in $HOME
+├─ config/           # items for $HOME/.config (e.g., nvim/)
+├─ scripts/          # installer and helper scripts
+├─ install.sh        # main entry point for setup
+├─ guake.conf        # terminal config (optional)
+├─ vimium.json       # browser keybindings (optional)
+├─ resticprofile.toml# restic profiles (optional)
+├─ sanoid.conf       # zfs-auto-snapshot profiles (optional)
+└─ private/          # local-only overrides (not tracked)
+```
 
-1. Check the `scripts/utils.sh` for debugging functions
-2. Run with `SYSTEM` variable set for additional debugging output
-3. Open an issue on GitHub with your system information
+(See the repo root for the actual files and directories.)
 
-## 🤝 Contributing
+---
 
-Feel free to:
-- Report bugs or issues
-- Suggest improvements
-- Submit pull requests
-- Share your own configurations
+## FAQ
 
-## 📄 License
+**Q: Can I pick and choose?**
+Yes. Run `source scripts/utils.sh` and then run the commands you'd like to run.
 
-This project is open source. Feel free to use, modify, and distribute as needed.
+**Q: macOS or Linux?**
+Both are supported; but currently `install.sh` focuses on android (termux), cachyos, and ubuntu.
 
 ---
 
-**Note**: The `private/` directory is intentionally not tracked in git and contains personal configurations that shouldn't be shared publicly.
+## License
+
+Open source—see the LICENSE file in the repo.

install.sh

@@ -2,43 +2,46 @@
 
 set -e
 
+DOTFILES_DIR=$(pwd)
+source "$DOTFILES_DIR/scripts/base_install.sh"
+
 # get the kernel string
 kernel=$(uname -r)
 case "$kernel" in
-  *"android"* )
-    ./scripts/phone.sh
-    ;;
-  *"azure"* ) # github action
-    export CI=true
-    if [[ $DEV_WORKSPACE != "" ]]; then
-      ./scripts/devcontainer.sh
-    else
-      ./scripts/main.sh
-    fi
-    ;;
-  *"generic"* )
-    if [[ $DEV_WORKSPACE != "" ]]; then
-      ./scripts/devcontainer.sh
-    else
-      ./scripts/main.sh
-    fi
-    ;;
-  *"cachyos"* )
-    ./scripts/nas.sh
-    ;;
-  *)
-    if [[ $(uname -o) == "Darwin" ]]; then
-      ./scripts/mac.sh
-    elif [[ $DEV_WORKSPACE != "" ]]; then
-      ./scripts/devcontainer.sh
-    else
-      echo \
-"
+*"android"*)
+  base_install "phone"
+  ;;
+*"azure"*) # github action
+  export CI=true
+  sudo apt-get install -y yq
+  if [[ $DEV_WORKSPACE != "" ]]; then
+    base_install "devcontainer"
+  else
+    base_install "ubuntu"
+  fi
+  ;;
+*"generic"*)
+  sudo apt-get install yq
+  if [[ $DEV_WORKSPACE != "" ]]; then
+    base_install "devcontainer"
+  else
+    base_install "ubuntu"
+  fi
+  ;;
+*"cachyos"*)
+  sudo pacman -S --needed --noconfirm yq
+  base_install "nas"
+  ;;
+*)
+  if [[ $DEV_WORKSPACE != "" ]]; then
+    base_install "devcontainer"
+  else
+    echo \
+      "
   Unknown system: $(uname -a)
   KTHNXBYE
 "
-      exit 1
-    fi
-    ;;
+    exit 1
+  fi
+  ;;
 esac
-