https://github.com/klappradla/dotfiles

🏗 how I set up my system
https://github.com/klappradla/dotfiles

dotfiles iterm2 macos neovim tmux zsh

Last synced: 6 days ago
JSON representation

🏗 how I set up my system

• Host: GitHub
• URL: https://github.com/klappradla/dotfiles
• Owner: klappradla
• Created: 2015-04-30T21:36:13.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2024-09-10T21:56:38.000Z (2 months ago)
• Last Synced: 2024-09-11T02:21:20.309Z (2 months ago)
• Topics: dotfiles, iterm2, macos, neovim, tmux, zsh
• Language: Shell
• Homepage:
• Size: 67.3 MB
• Stars: 5
• Watchers: 4
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# dotfiles 🏗

How I set up my dev system.

![screenshot](./screenshot.png)

## About

My dotfiles follow [holman](https://github.com/holman/dotfiles)'s concept of _"topical"_ organization. Each topic has its own directory with special filename conventions ⚡️:

- **bin/**: contains executables added to `$PATH`

- **topic/install**: script executed when installing/updating the topic

- **topic/link**: script executed when symlinking the topic

- **topic/name.symlink**: files picked up by the `link` script of the topic

_(Note: the `homebrew` topic is always evaluated first as other topics depend on it.)_

## Installation

_(on new computer: [set up ssh keys](https://docs.github.com/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) first)_

```bash

# start in the home directory

cd

# clone repository

git clone --recursive [email protected]:klappradla/dotfiles.git

# navigate into the new directory

cd dotfiles

# run the install script

script/setup

```

To install topics individually:

```bash

script/install 

```

## Tips & Tricks

- Change/disable macOS' default keyboard shortcuts for _"Input Sources"_ if you want to use CTRL + Space as prefix in Tmux.

_See [docs](./DOCS.md) for additional help._