emma-campbell/dotfiles

Overview

Here is a brief overview of how the project is organized.

.
├── README.md
├── aliases/
├── code/
├── func/
├── git/
├── lang/
├── os/
├── prompt/
├── shell/
└── symlinks/

• aliases/ contains all aliases, organized in files by type.
• code/ contains all IDE/editor configurations, in folders by type.
• func/ contains all helper functions
• git/ contains all git configuration
• lang/ contains all language specific configurations
• os/ contains all os-specific installations and preferences
• prompt/ contains prompt configuration
• shell/ contains all shell configuration
• symlinks/ contains all scripts that symlink important files to the root directory (~/)

Shell

• zsh
• zsh-autosuggestions
• zsh-syntax-highlighting
• zsh-completions

Prompt

• oh-my-posh
• fastfetch

Editors

• Visual Studio Code
• Neovim

Installation

⚠️ WARNING: While it's very easy to take someone's dotfiles and install them to your own machine, it's not recommended unless you understand exactly what you are doing and running.

I would highly recommended reading through the codebase before you decide to run the install script.

Given then warning, if you decide to continue, run the following.

1. Clone (or fork) the directory

git clone https://github.com/emma-campbell/dotfiles  ~/.dotfiles

2. Change Directories into ~/.dotfiles

cd ~/.dotfiles

3. Run the Bootstrap Script

sh bootstrap.sh

Inspiration

• holman/dotfiles
• alrra/dotfiles