Skip to content

Latest commit

 

History

History
115 lines (85 loc) · 5.38 KB

README.md

File metadata and controls

115 lines (85 loc) · 5.38 KB
Raw
           ▓█████▄  ▒█████  ▄▄▄█████▓  █████▒██▓ ██▓    ▓█████   ██████
           ▒██▀ ██▌▒██▒  ██▒▓  ██▒ ▓▒▓██   ▒▓██▒▓██▒    ▓█   ▀ ▒██    ▒
           ░██   █▌▒██░  ██▒▒ ▓██░ ▒░▒████ ░▒██▒▒██░    ▒███   ░ ▓██▄
           ░▓█▄   ▌▒██   ██░░ ▓██▓ ░ ░▓█▒  ░░██░▒██░    ▒▓█  ▄   ▒   ██▒
           ░▒████▓ ░ ████▓▒░  ▒██▒ ░ ░▒█░   ░██░░██████▒░▒████▒▒██████▒▒
           ▒▒▓  ▒ ░ ▒░▒░▒░   ▒ ░░    ▒ ░   ░▓  ░ ▒░▓  ░░░ ▒░ ░▒ ▒▓▒ ▒ ░
           ░ ▒  ▒   ░ ▒ ▒░     ░     ░      ▒ ░░ ░ ▒  ░ ░ ░  ░░ ░▒  ░ ░
           ░ ░  ░ ░ ░ ░ ▒    ░       ░ ░    ▒ ░  ░ ░      ░   ░  ░  ░
             ░        ░ ░                   ░      ░  ░   ░  ░      ░
           ░

✨ Dorian's Dotfiles ✨


Thanks for dropping by!

This is my personal collection of configuration files.

Here are some details about my setup:

screenshot image image

Feel free to "steal" anything you want, and if you have a question please open an issue.

Dependencies

The goal is to have all dependencies for the config automatically installed with the setup script. More details can be found by reading the following files:

Gotchas for NeoVim setup:

  • requires fd >= 8.4 (install from brew)
  • Tools such as formatters, LSPs, linters are automatically installed via :Mason, if one of the deps is not installing make sure to open :Mason to see the full error message.
  • Make sure to run :checkhealth to know if you are missing anything

Installation

Easy..

git clone [email protected]:dkarter/dotfiles.git

Cd into the dotfiles dir: cd dotfiles

./setup.sh

I don't recommend using other people's dotfiles, at least not when you're just starting with Vim.. these are customized to my personal taste and preferences, and are subject to change at any time. Instead consider forking kickstart.nvim, which is modern and very minimal, and using it as your base to build upon.

Ended up cloning anyway?

My dotfiles are now automatically versioned and contain a Changelog! The main branch will be continuously updated, and you can use git tags to check out specific versions.

⚠️ notice how I said automatically version and not semantically versioned. While I do try to keep a good git hygiene, and the versioning script follows conventional commits to determine the semantic version, I may still introduce a breaking change without a warning (these are my personal dotfiles after all :). The best course of action might be to have an independent fork and follow the changelog.

Releases and versioning is done using Release Please, GitHub Actions, and Conventional Commits

Development

  • This repo now uses conventional commits. To install the git hooks simply run yarn in the project directory
  • To start development use airmux (alias mux) inside the project directory

FAQ

Q: Why are things named without a dot at the beginning? A: It makes it easier to include files in this repo if they are not named exactly how they would be when symlinked over (I symlink the files here to my home directory). e.g. if I want to include the global `.gitignore` in this repo it will override this repo's `.gitignore`.