https://github.com/jakecobley/dotfiles
Dotfiles - personal preferences for various applications, editors, linters, and packages on macOS and Windows 10 with Windows Subsystem for Linux 2 (WSL2).
https://github.com/jakecobley/dotfiles
dotfiles macos windows-10 wsl2
Last synced: 4 months ago
JSON representation
Dotfiles - personal preferences for various applications, editors, linters, and packages on macOS and Windows 10 with Windows Subsystem for Linux 2 (WSL2).
- Host: GitHub
- URL: https://github.com/jakecobley/dotfiles
- Owner: jakecobley
- License: other
- Created: 2020-04-05T00:01:35.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-08-17T10:12:30.000Z (over 3 years ago)
- Last Synced: 2024-08-13T07:16:11.349Z (8 months ago)
- Topics: dotfiles, macos, windows-10, wsl2
- Language: Shell
- Homepage:
- Size: 16.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - jakecobley/dotfiles - Dotfiles - personal preferences for various applications, editors, linters, and packages on macOS and Windows 10 with Windows Subsystem for Linux 2 (WSL2). (Shell)
README
# Dotfiles
Dotfiles - personal preferences for various applications, editors, linters, and packages on macOS and Windows 10 with Windows Subsystem for Linux 2 (WSL2).
## Installation
1. Clone the dotfiles repository as a hidden directory (`.dotfiles`) with `$HOME`.
**NOTE**: On Windows, clone the dotfiles repository within Windows System for Linux 2 (WSL2) `$HOME` directory and not within Windows `$HOME`.
```BASH
git clone [email protected]:jakecobley/dotfiles.git $HOME/.dotfiles
```
1. Execute the `create-symlinks.sh` script and select the environment, `macOS` or `Windows 10 with Windows Subsystem for Linux 2 (WSL2)`, to symlink the dotfiles to their required destinations.
**NOTE**: Symlinks cannot be created between Windows Subsystem for Linux 2 (WSL2) and Windows. Dotfiles which are required within Windows (Windows applications e.g. Hyper) will be copied instead. Changes to these files will not be synced, and will be overwritten when running `./create-symlinks.sh`.
```BASH
$HOME/.dotfiles/create-symlinks.sh
```
**NOTE:** You'll likey have to modify the script's permissions to make it executable; `chmod +x create-symlinks.sh`.
## Usage
The dotfiles are synced between the local (devices) and remote (Github) via Git.
### Fetch Dotfiles
Fetch and apply the dotfiles from the remote repository (GitHub).
```BASH
git -C $HOME/.dotfiles pull; $HOME/.dotfiles/create-symlinks.sh
```
### Update Dotfiles
Push the local (device's) dotfiles to the remote repository (GitHub).
**NOTE:** Update the symlinks within the `create-symlinks.sh` script when adding and/or removing dotfiles.
```BASH
git -C $HOME/.dotfiles commit -a -m "Update dotfiles"; git -C $HOME/.dotfiles push
```
## Copyright and License
This project is licenced under the [ISC](https://github.com/jakecobley/dotfiles/blob/master/LICENCE) Licence - see the [LICENCE](https://github.com/jakecobley/dotfiles/blob/master/LICENCE) for details.