https://github.com/syknapse/dotfiles
macOS dotfiles repo
https://github.com/syknapse/dotfiles
Last synced: 9 months ago
JSON representation
macOS dotfiles repo
- Host: GitHub
- URL: https://github.com/syknapse/dotfiles
- Owner: Syknapse
- License: mit
- Created: 2021-10-20T18:49:19.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-04T12:40:20.000Z (11 months ago)
- Last Synced: 2025-03-30T06:24:08.628Z (10 months ago)
- Language: Shell
- Size: 55.7 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# .dotfiles
macOS dotfiles repo
## Installation
WARNING: This is currently not working properly. It creates the repo and symlinks correctly, and creates the projects and work directories, but all subsequent steps fail. Brew is not executing and not installing packages.
**This can be fixed by installing brew manually before installing this program**. Then it all works correctly
Clone the repo to .dotfiles directory in your home directory. Ex: `users/syknapse`
```bash
git clone ~/.dotfiles
```
With the terminal navigate to the dotfiles directory and then execute the install file
```bash
$ cd .dotfiles
# users/syknapse/.dotfiles
$ ./install
# starts installation process of all the dotfiles project
```
## Symlinks
To symlink a file in our dotfiles to the home directory we just need to add it to the `install.conf.yaml` file.
`~/.zshrc: zshrc` will create a .zshrc file in the home directory which is symbolically linked to the zshrc file in our .dotfiles directory.
## Create or modify the Brewfile
The following command uses Brew to create/modify the Brewfile with a full list of apps and packages installed on the machine, with a description.
These will be installed when we install the dotfiles project.
`brew bundle dump --force --describe` (aliased to `brewbd`)
## Keeping everything synced
When you make any changes to the dotfiles remember to commit and push to the repo. This way on any other machine you have installed dotfiles, you only need to pull the changes from the remote repo and run `./install` to sync the new changes.
## to do
- add explanation of work gitconfig (has to be init to be tested)
- add explanation of how to symlink
---
Based on this great course [dotfiles.eieio.xyz](http://dotfiles.eieio.xyz)