# dotfiles

**Repository Path**: dkdmg/dotfiles

## Basic Information

- **Project Name**: dotfiles
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: lz-ycy
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-01-17
- **Last Updated**: 2025-01-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# How to Use

## First install

Here is my install log: [dotfiles | insv の blog](https://blog.insv.xyz/dotfiles), it may help you get started.

- Init script from [Vaelatern/init-dotfiles: Quickly get your dotfiles up and running](https://github.com/Vaelatern/init-dotfiles)

    ```shell
    curl -fsSLO https://raw.githubusercontent.com/Vaelatern/init-dotfiles/master/init_dotfiles.sh
    chmod +x ./init_dotfiles.sh
    ./init_dotfiles.sh
    ```

- Modify your config files, for example, `~/.vimrc` , and tweak `.install.conf.yaml` 

    - Hidden files or directories do **not** require the prefix `.` 

        For example, `~/.vim` 

        1. `mkdir vim` 
        2. Add an entry in the `.install.conf.yaml`  file: `~/.vim:` 

    - If you are using git submodules, please make sure to add the submodule to the `gitconfig`  file.

        ```shell
        git submodule add -f <Github URL> <path>
        git submodule add -f https://github.com/tmux-plugins/tmux-cpu.git tmux/plugins/tmux-cpu
        ```

        

- Validate that the configuration is correct by running the `.install.conf.yaml` again

- Commit and push to GitHub

## Use on a new machine

- Create a directory, connect it to the remote repository, and then pull.

    ```shell
    mkdir .dotfiles && cd $_
    git init
    git remote add origin https://github.com/insv23/dotfiles.git
    git pull origin main
    ```

- Run `./install`  (if there are duplicate files or directories, manually delete them before running `./install` again).