feat: README

main
James Spencer 2023-10-01 21:10:28 +01:00
parent b7fb219e44
commit 798de3d12e
Signed by: james
SSH Key Fingerprint: SHA256:7tOVvkg3eVqn4GbEInHoSkEG96Cvqgvwx+VHUD9begc
2 changed files with 20 additions and 3 deletions

View File

@ -1,9 +1,28 @@
After installation # new Compooper
## Installation
```bash
./install.sh
```
The above script does the following:
1. Symlinks dotfiles to the home directory `~/`
2. Sets macOS defaults like Dark mode, pink highlight colours and natural scrolling
3. Installs Homebrew, a few packages and Applications
4. Installs Oh My Zsh
5. Installs Volta
## Post installation
- Set `gitconfig_work` to your work email address - Set `gitconfig_work` to your work email address
- Set up `.ssh/config` to use 1Password SSH Keys - Set up `.ssh/config` to use 1Password SSH Keys
- Provide `authToken` for work npm registry in `.npmrc` - Provide `authToken` for work npm registry in `.npmrc`
- Move everything in `.zshrc.pre-oh-my-zsh` to `.zshrc` - Move everything in `.zshrc.pre-oh-my-zsh` to `.zshrc`
- Login into VS Code to sync extensions
- Login into 1Password to sync vaults
- Login to 1Password CLI to sync SSH keys
## Programs requiring manual installation ## Programs requiring manual installation
- Session - Session

View File

@ -2,8 +2,6 @@
# Save the current working directory # Save the current working directory
DIR=$(pwd) DIR=$(pwd)
# TODO: Pretty colours (from holman)
# Go to the home directory # Go to the home directory
cd ~ cd ~