My Dotfiles

This repository contains my configuration files ("dotfiles") for various tools and applications.

Table of Contents

• Overview
• Directory Structure
• Installation
• Usage
• Customization
• Contributing
• License
• Contact

Overview

This repository holds configurations for multiple tools including:

• btop: Terminal system monitor.
• gdb: GNU Debugger customizations.
• kitty: Terminal emulator settings.
• nvim: Neovim configurations with a lazy plugin loader and Lua scripts.
• starship: Minimalistic shell prompt.
• vale: Linting and style guides.
• zsh: Shell customizations.

The goal of these dotfiles is to provide a robust and customizable development environment that enhances productivity and system monitoring.

Directory Structure

Below is an overview of the repository's structure:

.
├── btop
│   ├── btop.conf
│   └── themes
├── gdb
│   └── gdbinit
├── kitty
│   ├── keymap.conf
│   ├── kitty.conf
│   ├── layout.conf
│   ├── tab_bar.py
│   └── theme.conf
├── nvim
│   ├── init.lua
│   ├── lazy-lock.json
│   └── lua
│       ├── core
│       │   ├── keymaps.lua
│       │   └── options.lua
│       └── plugins
│           ├── alpha.lua
│           ├── autocompletion.lua
│           ├── autoformat.lua
│           ├── autopairs.lua
│           ├── avante.lua
│           ├── bufferline.lua
│           ├── dashboard.lua
│           ├── debug.lua
│           ├── eslint.lua
│           ├── gitsigns.lua
│           ├── indent_line.lua
│           ├── lint.lua
│           ├── lsp.lua
│           ├── mini.lua
│           ├── neo-tree.lua
│           ├── telescope.lua
│           ├── themes
│           │   └── tokyonight.lua
│           ├── todo_comments.lua
│           ├── treesitter.lua
│           ├── trouble.lua
│           ├── typst_preview.lua
│           ├── vimtex.lua
│           └── which_key.lua
├── starship
│   └── starship.toml
├── vale
│   ├── alex
│   │   └── meta.json
│   └── RedHat
│       ├── collate-output.tmpl
│       ├── meta.json
│       └── README-IBM.adoc
└── zsh
    ├── aliases.zsh
    ├── custom.zsh
    ├── git-completion.bash
    └── git-completion.zsh

Installation

1. Clone the Repository:

   git clone https://github.com/SOV710/dotfiles.git ~/.dotfiles
   cd ~/.dotfiles

2. Create Symlinks:

   Use a symlink manager (e.g., GNU Stow, dotbot, or a custom script) to link the configuration files to their respective locations.

   # Example using GNU Stow
   stow -t ~ nvim
   stow -t ~ kitty
   stow -t ~ zsh
   # ...repeat for other directories as needed

3. Additional Setup:

   • Neovim: Ensure you have Neovim installed. You may need to run your lazy loader or plugin manager to install plugins.
   • zsh: Verify your zsh installation and update your shell to use the custom configurations.
   • Other Tools: Refer to the individual configuration files for further tool-specific instructions.

Usage

• btop: Customize btop.conf and add new themes in the themes folder.
• gdb: Modify gdbinit to fit your debugging preferences.
• kitty: Adjust settings in kitty.conf or change layouts with layout.conf and keybindings via keymap.conf.
• nvim: The core configuration is in init.lua and extended with Lua modules in the lua directory.
• starship: Update starship.toml to modify your shell prompt.
• vale: Use the style guide configurations under vale to maintain consistency in documentation.
• zsh: Customize your shell experience by modifying aliases.zsh, custom.zsh, and enabling git completions.

Customization

Feel free to customize any configuration file to suit your workflow:

• Themes & Colors: Adjust theme configurations in kitty, nvim/plugins/themes, or starship.
• Keybindings: Modify nvim/lua/core/keymaps.lua and kitty/keymap.conf to match your shortcuts.
• Plugins: Explore and add new plugins in the nvim/lua/plugins directory.

Contributing

Contributions are welcome! If you'd like to propose changes or enhancements, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Commit your changes with clear messages.
4. Open a pull request detailing your changes.

License

This project is licensed under the MIT License.

Contact

For any questions, suggestions, or issues, please open an issue on GitHub or contact me at chris916911179@outlook.com.

---

Happy configuring!