From a5ede614473523077f69ad0fd09ee527151d0e21 Mon Sep 17 00:00:00 2001 From: rjzupkoii Date: Sun, 16 Jun 2024 10:31:17 -0400 Subject: [PATCH] Update README.md --- README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d4ab76133b79f..5e1f5134fa8b5 100644 --- a/README.md +++ b/README.md @@ -21,14 +21,18 @@ See more info at https://academicpages.github.io/ When you are initially working your website, it is very useful to be able to preview the changes locally before pushing them to GitHub. To work locally you will need to: 1. Clone the repository and made updates as detailed above. -1. Make sure you have ruby-dev, bundler, and nodejs installed: - -- `sudo apt install ruby-dev ruby-bundler nodejs` -- For MacOS install ruby, bundler and node via Homebrew: - - `brew install ruby` - - `brew install node` - - `gem install bundler` - +1. Make sure you have ruby-dev, bundler, and nodejs installed + + On most Linux distribution and [Windows Subsystem Linux](https://learn.microsoft.com/en-us/windows/wsl/about) the command is: + ```bash + sudo apt install ruby-dev ruby-bundler nodejs + ``` + On MacOS the commands are: + ```bash + brew install ruby + brew install node + gem install bundler + ``` 1. Run `bundle install` to install ruby dependencies. If you get errors, delete Gemfile.lock and try again. 1. Run `jekyll serve -l -H localhost` to generate the HTML and serve it from `localhost:4000` the local server will automatically rebuild and refresh the pages on change.