Skip to content

Commit ded2745

Browse files
committed
simplified dotfiles to a single section
1 parent cda56ad commit ded2745

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

_partials/dotfiles_simple.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
## Dotfiles
2+
3+
Let's jazz up your terminal, zsh, and VS Code by installing Le Wagon's curated [dotfiles](http://github.com/lewagon/dotfiles) **on your Virtual Machine**.
4+
5+
To make this setup your own and customise it further to suit yourself, you'll need to make a _fork_ of it and store it on your own Github account.
6+
7+
Forking means that it will create a new repo in your GitHub account, identical to the original one. You'll have a new repository on your GitHub account, `your_github_username/dotfiles`. We need to fork because each of you will need to put specific information (e.g. your name) in those files.
8+
9+
Open your terminal on your VM and run the following command:
10+
11+
```bash
12+
export GITHUB_USERNAME=`gh api user | jq -r '.login'`
13+
echo $GITHUB_USERNAME
14+
```
15+
16+
You should see your Github username printed.
17+
18+
❗ If you do not see your Github username being printed - **stop here** - and raise a ticket with a TA 🙋 There may be a problem with the previous step (`gh auth`).
19+
20+
Time to fork the repo and clone it on your Virtual Machine:
21+
22+
```bash
23+
mkdir -p ~/code/$GITHUB_USERNAME && cd $_
24+
gh repo fork lewagon/dotfiles --clone
25+
```
26+
27+
Run the `dotfiles` installer with:
28+
29+
```bash
30+
cd ~/code/$GITHUB_USERNAME/dotfiles && zsh install.sh
31+
```
32+
33+
Check the emails registered with your GitHub Account. You'll need to pick one
34+
at the next step:
35+
36+
```bash
37+
gh api user/emails | jq -r '.[].email'
38+
```
39+
40+
Run the git installer:
41+
42+
```bash
43+
cd ~/code/$GITHUB_USERNAME/dotfiles && zsh git_setup.sh
44+
```
45+
46+
:point_up: This will **prompt** you for your name (`FirstName LastName`) and your email.
47+
48+
:warning: You **need** to put one of the emails listed above thanks to the previous `gh api ...` command.
49+
If you don't enter a valid email, Kitt will not be able to track your progress. 💡 Select the `@users.noreply.github.com` address if you don't want your email to appear in public repositories you may contribute to.

0 commit comments

Comments
 (0)