/dotfiles

A collection of configuration files for setting up a developer-friendly environment.

Primary LanguageShell

Dotfiles Repository

This repository manages configuration files for various tools and utilities using Git submodules, helping to maintain a consistent and easily reproducible development environment across different machines.

Getting Started

Requirements

Global deps

Terminal deps

Home deps

nvim deps

different

  • btop system monitoring tool

Notes

Core theme - catppuccin Mocha

Installation

  1. Clone the repository along with its submodules:

    git clone --recurse-submodules git@github.com:cjvnjde/dotfiles.git $HOME/dotfiles
  2. Run the setup script to create symbolic links for your dotfiles:

    $HOME/dotfiles/setup.sh

Usage

Adding New Dotfiles

  1. Add the external configuration repository as a submodule:

    git submodule add git@github.com:cjvnjde/reponame.git path/to/repo
  2. Update the associative array in the setup.sh script:

    dotfiles=(
    ...
    "path/to/file:path/to/symbolic"
    )
  3. Run the setup script to create the symbolic link:

    $HOME/dotfiles/setup.sh
  4. Commit and push your changes:

    git add .
    git commit -m "Add repo submodule"
    git push

Updating Dotfiles

  1. Pull the latest changes, including submodule updates:

    git pull --recurse-submodules
  2. Run the setup script to apply the changes:

    ./setup.sh

Platform Specific Configuration for Zsh

  1. Navigate to Your Home Directory:

    cd $HOME
  2. Create the .zshrc_local File:

    If it doesn't already exist, create the .zshrc_local file.

    touch .zshrc_local
  3. Edit the .zshrc_local File:

    Open the file in your preferred text editor.

    nano .zshrc_local  # or use vim, code, etc.

    Add your platform-specific configurations, aliases, environment variables, etc., to this file.