https://github.com/freyskeyd/dotfiles
https://github.com/freyskeyd/dotfiles
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/freyskeyd/dotfiles
- Owner: Freyskeyd
- Created: 2024-05-27T08:25:51.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-06-03T07:01:13.000Z (about 1 year ago)
- Last Synced: 2025-07-29T09:25:17.224Z (11 months ago)
- Language: Lua
- Size: 301 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Dotfiles
## Contents ##
1. [Details](#details)
2. [Features](#features)
3. [Dependencies](#dependencies)
4. [Installation](#installation)
5. [Folder Structure](#folder-structure)
## Details ##
+ **Shell**: ZSH
+ **Theme**: OneNord
+ **Terminal**: Wezterm
## Features ##
+ lightweight
+ Easy installation / configuration
+ Very few dependencies
+ Neovim configuration
+ Tiling window manager
+ Hotkey daemon
|Dependency|Description|Install|
|:----------:|:-------------:|:---:|
|`homebrew`|Package Manager for macOS| [Install](https://brew.sh/)
## Installation
After installing `homebrew`, clone this repository (the path to the repo will be define as `DOTFILES_PATH` for the rest of the `README`).
The repository contains various folder, you can use all of them or pick only the one you want.
However, the `brew` install will install all packages needed. If you want to remote some dependencies, you need to edit the file in `DOTFILES_PATH/brew`.
```bash
# Move to clone dotfiles directory
$ cd DOTFILES_PATH
# Install brew deps
$ brew bundle --file=brew/Brewfile
# Sync directories to ~/.config
$ stow --target ~/.config .
```
If you want to have access to the same capabilities regarding yabai, you need to follow the [steps](https://github.com/koekeishiya/yabai/wiki/Disabling-System-Integrity-Protection)
## Folder Structure
- `brew`: Contains a `Brewfile` to install dependencies
- `gh`: Configuration for the [GH](https://cli.github.com/) cli
- `gh-dash`: Configuration for [GH-dash](https://github.com/dlvhdr/gh-dash) dashboard
- `git`: Configuration for `git`
- `nvim`: Configuration for `neovim`
- `rustfmt`: Configuration of the `rustfmt` tool
- `skhd`: Configuration and keybindings for [skhd](https://github.com/koekeishiya/skhd) daemon
- `starship.toml`: Configuration for the [starship](https://starship.rs/) prompt
- `tmux`: Configuration for tmux
- `wezterm`: Configuration for the [wezterm](https://wezfurlong.org/wezterm/) terminal emulator
- `yabai`: Configuration for [yabai](https://github.com/koekeishiya/yabai) (extra installation steps are needed for yabai, see below)
- `zsh`: Zsh configurations