kergoth / dotfiles

Primary dotfiles & scripts repository
Other
21 stars 1 forks source link

Kergoth's Dotfiles and Setup Scripts

BlueOak 1.0.0 License

This repository includes my personal application configuration and settings (dotfiles), as well as scripts for setting up systems per my personal preferences.

Prerequisites

Usage

Initial dotfiles setup

This setup will apply the dotfiles, and will also install packages with home-manager, if nix is installed.

If the repository has not yet been cloned:

chezmoi init --apply kergoth/dotfiles

If the repository is already cloned and you've changed directory to it:

./script/setup

User Setup

This setup will apply the dotfiles, but will also apply other changes to the current user configuration.

After cloning the repository, and changing directory to it, run:

./script/setup-user

On windows (in powershell, not WSL), run this instead:

./script/setup-user.ps1

System Setup

On Arch and FreeBSD, early setup scripts exist in ./script/arch and ./script/freebsd, respectively. These are self-contained and may be used without cloning the repository:

The setup-system script is run by a non-root user with sudo/doas access, to perform post-install system-level setup and configuration. This script will apply changes to the system as a whole. This may include installing packages through the package manager, installing nix, et cetera. Ideally this should be run prior to setting up the user, and should be run as a user with sudo access.

After cloning the repository, and changing directory to it, run:

./script/setup-system

On windows (in powershell, not WSL), run this instead:

./script/setup-system.ps1

Edit dotfiles

chezmoi edit --watch ~/.config/zsh/.zshrc

Apply dotfiles changes to the home directory

This step is implicitly done by the boostrap script. To run it manually, for example, after editing files inside the repository checkout, run this:

chezmoi apply

Update the dotfiles, including external files

chezmoi update -R

Update the dotfiles, external files, and home directory packages

./script/update

Manual Setup Steps

Manual Setup Steps for macOS

Manual Setup Steps for Windows

What's Included

Dotfiles

Zsh Plugins

External Scripts included for non-Windows platforms

Fonts

Installed CLI Software

CLI Software on Linux and macOS

CLI Software on Linux, macOS, and FreeBSD

CLI Software on Linux, macOS, and Windows

CLI Software on macOS

CLI Software on Linux and FreeBSD

The intention is to incorporate the installation of Nix on all systems in time.

CLI Software on Arch Linux
CLI Software on WSL2

CLI Software on Windows

Powershell Modules

Powershell Modules on Windows only

Installed GUI Software (MacOS & Windows Only)

GUI Software on Windows and macOS

GUI Software on macOS (Pre-Sonoma Only)

GUI Software on macOS

Safari Extensions
QuickLook Plugins

GUI Software on Windows

Apps I install on an as-needed basis

As needed CLI Software

On my NAS, to download what I own

To deal with icons and images

For beets

As Needed CLI Software for macOS

As Needed GUI Software

As Needed GUI Software for macOS

As Needed GUI Software for Windows (All are available via winget)

Formerly-Used

Formerly-Used Applications

Formerly-Used Fonts

Formerly-Used Fonts - Occasional Use

Implementation Notes

Reference

Chezmoi Usage

Supported Platforms

Help

Questions and comments are always welcome, please open an issue.

Contributing

Contributions of all kinds, including feedback, are always welcome!

See CONTRIBUTING.md for ways to get started.

Please adhere to this project's Code of Conduct and follow The Ethical Source Principles.

License

Distributed under the terms of the Blue Oak Model License 1.0.0 license.

See Also

Superseded Projects

Mostly Superseded Projects