Skip to content

Latest commit

 

History

History
123 lines (82 loc) · 5.6 KB

README.md

File metadata and controls

123 lines (82 loc) · 5.6 KB
Raw

htv-dotfiles

HTV04's awesome dotfiles.

The official repository can be found here, in case you're looking at a fork or mirror.

Note

Nothing crazy here right now, as I'm still figuring out what to include. My goal with this repository is to provide an optimal configuration without anything unnecessary or user-specific. In other words, expect more stuff very soon.

Dependencies

  • Chezmoi: Dotfile manager
  • FiraMono Nerd Font: Font used in terminal emulators
  • OpenDoas: Privilege elevation
  • Vi: Default editor, intended for small files
  • Zsh: Shell used for terminal emulators

The login shell must also source .profile. DASH is the preferred login shell.

Configured software

  • Bash
  • Bat: ANSI theme
  • Electron: Wayland support
  • Foot
    • Intended to be used in server and client mode.
  • Git
    • Create ~/htv-local/etc/gitconfig for local configuration.
  • Makepkg: Disable package compression
  • Paru
  • SDL: Wayland support
  • Zsh

The software in this list is optional, but it's recommended to install them (as applicable) for the best experience.

Additional files

Most of these files that do not provide any core configuration on their own, but rather are support files that can be used for additional configuration. For example, to install the Firefox preferences file:

Warning

This will delete your existing Firefox profile data.

rm -r ~/.cache/mozilla/firefox/*.default-release
rm -r ~/.mozilla/firefox/*.default-release/*
cp ~/htv-local/share/firefox-prefs.js ~/.mozilla/firefox/*.default-release/prefs.js

Recommended software

This software isn't configured by the dotfiles (with the exception of additional files), but I still recommend installing them, as I use them in my personal configurations.

Environment

Directory: ~/htv-local

The layout of this directory is based on that of the Unix filesystem. Any custom binaries, scripts, and other support files that do not have an official directory are available here.

In my personal configurations, I use this directory for all of my local files, and it generally assures me that no random applications will write their own files into it.

Variable: HTV_TERM

This variable controls the terminal features used by supported configurations. If set to full, text formatting, true color, and Nerd Fonts symbols will be used. If unset or set to any other value, no terminal features or special characters will be used.

Installation

To begin installation, run:

chezmoi init https://codeberg.org/HTV04/htv-dotfiles.git

Note

Mirrors may not be updated as frequently, so you should only replace the URL above if you're using a fork.

You will be prompted for the following:

Platform

The following platforms are supported:

  • Arch Linux: archlinux
  • Artix Linux: artixlinux
  • Linux (generic): linux
  • Unix-like: unix

The default will be one of these platforms, if detected. The chosen platform determines which dotfiles will be used and adjusts their contents as necessary.

Warning

The platform detection is not the most optimal. For example, using an Arch-based distribution that isn't listed above will use linux as the default. Using the closest option to your platform is preferred, so don't always rely on the default.

Catppuccin palette

The following Catppuccin palettes are available:

  • Latte: latte
  • Frappé: frappe
  • Macchiato: macchiato
  • Mocha: mocha

The default is latte. The selected palette will be used as a color scheme where applicable.

Contributing

Suggestions and fixes are very welcome. However, I won't accept new configurations, or drastic modifications to existing configurations. If you would like to do this, consider creating a fork instead.

License

"htv-dotfiles" is licensed under the MIT License.