Skip to content

Commit 806a1e3

Browse files
Merge pull request #8 from desmondwong1215/update/readme
Update README.md for Windows/Ubuntu users
2 parents 688fad3 + df943d1 commit 806a1e3

1 file changed

Lines changed: 44 additions & 14 deletions

File tree

README.md

Lines changed: 44 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,51 @@ Install the following tools first:
1010

1111
- Ruby 3.2.2
1212

13-
| Note: the installation commands below are for macOS using Homebrew only. Adjust as needed for your OS and package manager.
13+
Use one of the following OS-specific options.
1414

15-
```bash
16-
brew install rbenv ruby-build
17-
rbenv install 3.2.2
18-
echo 'eval "$(rbenv init - zsh)"' >> ~/.zshrc
19-
source ~/.zshrc
20-
rbenv global 3.2.2
21-
ruby -v
22-
```
15+
macOS (Homebrew + rbenv):
16+
17+
```bash
18+
brew install rbenv ruby-build
19+
rbenv install 3.2.2
20+
echo 'eval "$(rbenv init - zsh)"' >> ~/.zshrc
21+
source ~/.zshrc
22+
rbenv global 3.2.2
23+
ruby -v
24+
```
25+
26+
Ubuntu/Debian (rbenv):
27+
28+
```bash
29+
sudo apt update
30+
sudo apt install -y git curl build-essential libssl-dev zlib1g-dev \
31+
libreadline-dev libyaml-dev libsqlite3-dev sqlite3 libxml2-dev \
32+
libxslt1-dev libcurl4-openssl-dev libffi-dev libgdbm-dev libncurses5-dev
33+
curl -fsSL https://github.com/rbenv/rbenv-installer/raw/main/bin/rbenv-installer | bash
34+
export PATH="$HOME/.rbenv/bin:$PATH"
35+
eval "$(rbenv init - bash)"
36+
rbenv install 3.2.2
37+
rbenv global 3.2.2
38+
ruby -v
39+
```
40+
41+
Windows (RubyInstaller + ridk):
42+
43+
1. Download and install Ruby 3.2.x from [RubyInstaller](https://rubyinstaller.org/downloads/).
44+
2. Choose the installer named `Ruby+Devkit 3.2.x (x64)` for most systems.
45+
Use `x86` only if your Windows is 32-bit.
46+
3. During install, keep the option to run `ridk install` enabled.
47+
4. Open a new PowerShell and verify:
48+
49+
```powershell
50+
ruby -v
51+
```
2352

2453
- Bundler
2554

26-
```bash
27-
gem install bundler
28-
```
55+
```bash
56+
gem install bundler
57+
```
2958

3059
## Run locally
3160

@@ -67,7 +96,8 @@ bundle exec jekyll build
6796

6897
## Troubleshooting
6998

70-
- `bundle: command not found`: install Bundler with `gem install bundler`.
71-
- Shell still reports wrong Ruby version: run `rbenv version` to confirm 3.2.2 is active; if not, run `rbenv global 3.2.2` and restart the terminal.
99+
- `bundle: command not found`: ensure Ruby and Bundler are installed, then open a new shell and run `gem install bundler`.
100+
- Ruby version is not 3.2.2 on macOS/Linux: confirm with `ruby -v`, then set with `rbenv global 3.2.2`.
101+
- Ruby version is not 3.2.2 on Windows: reinstall Ruby 3.2.x from RubyInstaller and reopen PowerShell.
72102
- Port `4000` already in use: run `bundle exec jekyll serve --port 4001`.
73103
- Styling or content not updating: restart `jekyll serve` and hard refresh your browser.

0 commit comments

Comments
 (0)