windows setup
gl to linux/macos people. its mostly the same so u got it :)
Download VS Code
- Click big download button for Windows https://code.visualstudio.com/download
- Download the Dev Container extension
Download WSL
See official documentation here: https://learn.microsoft.com/en-us/windows/wsl/install
- Open Powershell
- Type
wsl --set-default-version 2
- Type
wsl --install
- If you are prompted to put in credentials, put something you will remember
Unix systems do not show input while you are typing passwords by default! (type carefully :D )
Download Docker
Make sure to have Docker running for later!
Download Git
Set up SSH Authentication for GitHub
- See existing Newbie Guide doc here
Clone RobotathonESP32 Repository
- Go to the Robotathon repository
- Click the green
<> Code
button
- Copy the SSH Link (HTTPS bad and sucks 👎)
- Open Git Bash and navigate to where you want to keep the code by using
ls
andcd
- Run the following command in your Git terminal:
git clone [LINK HERE]
without the square brackets
Opening the Container
- Navigate to
RobotathonESP32
by usingls
andcd
- Type
git checkout newbie-guide-2025
to switch to the Newbie Guide branch - Open
RobotathonESP32
in VS Code - Click the
><
icon in the bottom left corner of VS Code - Click
Reopen in Container
from the popup at the top of VS Code
Setting Up and Using Jekyll (viewing local changes)
- Once everything has loaded, open a terminal within VS Code (View > Terminal,
Ctrl +
`, etc.) - Type
cd docs
and pressEnter
- Type
bundle install
and pressEnter
- Type
bundle exec jekyll serve --force_polling --livereload
and pressEnter
Ctrl
+Left Click
on the server address link to open the site locally after it is done compiling
You do not need to rerun any terminal commands to view changes if you use the --force_polling
and --livereload
flags. If your computer is blowing up with constant autoreload, you can just use bundle exec jekyll serve
, but you’ll have to rerun the command each time you want to render new local changes
Writing to Live Website
- Make change
- Navigate to
RobotathonESP32
in Git Bash - Commit and push changes (How?)
- Observe changes on live website in about a minute