Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ethanbyeon/dotfiles
●_FILES
https://github.com/ethanbyeon/dotfiles
dotfiles fish neovim starship tmux vscode
Last synced: about 1 month ago
JSON representation
●_FILES
- Host: GitHub
- URL: https://github.com/ethanbyeon/dotfiles
- Owner: ethanbyeon
- Created: 2024-08-30T06:15:26.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-11-08T08:44:34.000Z (3 months ago)
- Last Synced: 2024-11-08T09:33:52.774Z (3 months ago)
- Topics: dotfiles, fish, neovim, starship, tmux, vscode
- Language: Lua
- Homepage:
- Size: 1.83 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
EYB's Dotfiles
Starship Config
tmux Config
## Setup Overview
- **Default Shell**: [Fish](https://github.com/fish-shell/fish-shell)
- **Shell Prompt**: [Starship](https://github.com/starship/starship)
- **Terminal Multiplexor**: [tmux](https://github.com/tmux/tmux/wiki/Installing)
- **Text Editors**: [Neovim](https://github.com/neovim/neovim), [VS Code](https://code.visualstudio.com/)
## Directory Structure
```
~/dotfiles/
├── .config/
│ ├── nvim/
│ ├── starship/
│ └── tmux/
├── images/
├── vscode/
└── README.md
```
## Installation
> [!NOTE]
> If you have existing configuration files you want to manage, please refer to the [Using GNU Stow](#using-gnu-stow) section for guidance on backing up and handling your current setups.
To set up these dotfiles using GNU Stow, follow the steps below:
1. **Clone the repository**:
```
git clone https://github.com/ethanbyeon/dotfiles.git ~/dotfiles
cd ~/dotfiles
```
2. **Install GNU Stow**:
For macOS (Homebrew):
```
brew install stow
```
3. **Create Symlinks for Configurations**:
To symlink the configuration files (e.g., for `nvim`, `zsh`, or `tmux`), run:
```
stow
```
Replace `` with the directory name of the configuration you want to symlink (e.g., `nvim`, `zsh`).
> [!TIP]
> After running the `stow` command, confirm that the configuration files are correctly placed and loaded on your system.
## Using GNU Stow
[GNU Stow](https://www.gnu.org/software/stow/manual/stow.html) helps manage and symlink configuration files from your dotfiles repository to their appropriate locations. Follow these steps to set it up:
### 🔄 Backing Up Existing Configurations
To move your current configurations into your dotfiles repository, use the `--adopt` flag:
```
stow --adopt
```
This command will move any existing files (e.g., `~/.zshrc`) into your dotfiles repository. Ensure the repository's directory structure matches your system's file paths.
> [!WARNING]
> The `--adopt` flag will overwrite any files in the repository with the same name as those being moved.
### 🔗 Symlinking Configurations
1. Clone the repository and navigate into its directory.
2. Create symlinks for the desired packages using Stow:
```
stow
```
This will link the configuration files from your dotfiles repository to their corresponding locations on your system (e.g., `~/.config/nvim/`).
