https://github.com/ashudevcodes/dotfiles
Dotfile for Window WSL Linux Environment
https://github.com/ashudevcodes/dotfiles
dotfiles linux lua nvim
Last synced: 2 months ago
JSON representation
Dotfile for Window WSL Linux Environment
- Host: GitHub
- URL: https://github.com/ashudevcodes/dotfiles
- Owner: ashudevcodes
- License: mit
- Created: 2024-05-31T17:29:03.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-07-07T03:50:48.000Z (11 months ago)
- Last Synced: 2025-01-26T12:11:41.856Z (4 months ago)
- Topics: dotfiles, linux, lua, nvim
- Language: Lua
- Homepage:
- Size: 37.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dotfiles Repository
This repository contains my personal dotfiles for configuring a Linux environment. The dotfiles include configurations for Zsh, Neovim, Neofetch, Tmux, and the Starship prompt. I use GNU Stow to manage the symbolic links for these configuration files.
## Contents
- `.zshrc`: Configuration file for Zsh.
- `config/`: Directory containing application-specific configurations.
- `nvim/`: Configuration for Neovim.
- `neofetch/`: Configuration for Neofetch.
- `tmux/`: Configuration for Tmux.
- `starship.toml`: Configuration for the Starship prompt.
## Prerequisites
- **GNU Stow**: A symlink farm manager to manage the installation of dotfiles.
- **Zsh**: A powerful shell.
- **Neovim**: A modern fork of Vim.
- **Neofetch**: A command-line system information tool.
- **Tmux**: A terminal multiplexer.
- **Starship**: A minimal, blazing-fast, and customizable prompt for any shell.
## Installation
1. **Clone the repository**:
```bash
git clone https://github.com/ashudevcodes/dotfiles.git
cd dotfiles
```
2. **Install the required tools**:
- Zsh: `sudo apt install zsh`
- Neovim: `sudo apt install neovim`
- Neofetch: `sudo apt install neofetch`
- Tmux: `sudo apt install tmux`
- Starship: Follow the installation guide on the [Starship website](https://starship.rs/).
3. **Use Stow to create symbolic links**:
```bash
stow -t ~ zsh
stow -t ~ config
```
This will create symbolic links for the `.zshrc` file and the configuration files within the `~/.config` directory.
## Directory Structure
```plaintext
dotfiles/
├── .zshrc
└── config/
├── nvim/
│ └── (Neovim configuration files)
├── neofetch/
│ └── (Neofetch configuration files)
├── tmux/
│ └── (Tmux configuration files)
└── starship.toml
```
## Customizing
Feel free to modify any of the configuration files to suit your preferences. Each configuration file is well-documented to help you understand the settings and make changes as needed.
## Updating Configurations
If you make changes to the configurations and want to update the symbolic links, simply run the `stow` command again:
```bash
stow -t ~ zsh
stow -t ~ config
```
## Contributing
If you have suggestions or improvements, feel free to open an issue or submit a pull request. Contributions are welcome!
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.