Skip to content

Commit cf88399

Browse files
chore: Update setup instructions to be clearer
1 parent a0a27fa commit cf88399

File tree

2 files changed

+42
-11
lines changed

2 files changed

+42
-11
lines changed

.gitconfig

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,7 @@
171171
email = sanyam.khurana01@gmail.com
172172
name = Sanyam Khurana
173173
signingkey = 3448C4F62756E5480FA0F378D07B36A0F0870851
174+
timezone = America/Toronto
174175
175176
[commit]
176177
template = ~/.gitmessage

README.md

Lines changed: 41 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,55 @@ OS related setup scripts can be found in `setup` folder.
1515

1616
## Setup
1717

18-
If you are using Mac OSX, this repo includes a script to install dependencies in this [script](setup/setup_mac.sh).
18+
### 1. Clone the repository
1919

20-
curl -L http://git.io/curiouslearner-setup-mac | sh
20+
```shell
21+
cd ~
22+
git clone --recursive https://github.com/CuriousLearner/dotfiles.git
23+
cd ~/dotfiles
24+
```
25+
26+
### 2. Install Mac dependencies (macOS only)
27+
28+
```shell
29+
sh setup/setup_mac.sh
30+
```
31+
32+
Or via curl:
33+
34+
```shell
35+
curl -L http://git.io/curiouslearner-setup-mac | sh
36+
```
37+
38+
### 3. Set macOS defaults (optional)
2139

22-
This [script](setup/osx_defaults.sh) will help you add some defaults to your mac.
40+
```shell
41+
sh setup/osx_defaults.sh
42+
```
43+
44+
### 4. Create symlinks
2345

24-
### Installing dotfiles
46+
This creates symbolic links from your home directory to the dotfiles, keeping everything maintainable in git:
47+
48+
```shell
49+
sh bootstrap.sh
50+
```
2551

26-
Once you have installed basics software and libraries, you can install the dotfiles, by cloning this repo into `~/dotfiles` and symlinking the files inside it to your home directory `~`. Symlinking helps keep all your dotfiles maintainable inside a git repo, while being functional at the same time.
52+
### 5. Install Python packages
2753

2854
```shell
29-
cd ~ && git clone --recursive git@github.com:curiouslearner/dotfiles.git && cd ~/dotfiles
30-
# To create symbolic links in your home
31-
sh bootstrap.sh ## this will create the required symlinks
32-
pip install -r setup/requirements.pip ## essential python packages needed
33-
cd ~/dotfiles/setup/vscode && setup-vs-code.sh # this will create symlink to settings.json file & install extensions.
55+
pip install -r setup/requirements.pip
3456
```
3557

36-
__NOTE__: To update the list of vs-code-extensions use alias `eve` that would update the file `~/dotfiles/setup/vscode/install-extensions.sh`
58+
### 6. Setup VS Code (optional)
59+
60+
```shell
61+
cd ~/dotfiles/setup/vscode && sh setup-vs-code.sh
62+
```
63+
64+
This creates a symlink to `settings.json` and installs extensions.
65+
66+
**Tip:** Use the alias `eve` to update the VS Code extensions list in `~/dotfiles/setup/vscode/install-extensions.sh`
3767

3868
## Resources
3969

0 commit comments

Comments
 (0)