Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rjzupkoii authored Jun 16, 2024
1 parent 23c37c2 commit a5ede61
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit a5ede61

Please sign in to comment.