Merge pull request #1 from cambridge-mlg/update-bundle-lock

Update lock and README

Gemfile.lock

@@ -1,17 +1,17 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
     colorator (1.1.0)
-    concurrent-ruby (1.1.8)
-    em-websocket (0.5.2)
+    concurrent-ruby (1.2.2)
+    em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
-      http_parser.rb (~> 0.6.0)
+      http_parser.rb (~> 0)
     eventmachine (1.2.7)
-    ffi (1.15.0)
+    ffi (1.16.3)
     forwardable-extended (2.6.0)
-    http_parser.rb (0.6.0)
+    http_parser.rb (0.8.0)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
     jekyll (3.9.0)
@@ -27,38 +27,39 @@ GEM
       pathutil (~> 0.9)
       rouge (>= 1.7, < 4)
       safe_yaml (~> 1.0)
-    jekyll-feed (0.15.1)
+    jekyll-feed (0.17.0)
       jekyll (>= 3.7, < 5.0)
     jekyll-sass-converter (1.5.2)
       sass (~> 3.4)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
-    kramdown (2.3.1)
+    kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
-    liquid (4.0.3)
-    listen (3.5.1)
+    liquid (4.0.4)
+    listen (3.8.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     mercenary (0.3.6)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    public_suffix (4.0.6)
-    rb-fsevent (0.10.4)
+    public_suffix (5.0.4)
+    rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rexml (3.2.5)
-    rouge (3.26.0)
+    rexml (3.2.6)
+    rouge (3.30.0)
     safe_yaml (1.0.5)
     sass (3.7.4)
       sass-listen (~> 4.0.0)
     sass-listen (4.0.0)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
-    webrick (1.7.0)
+    webrick (1.8.1)
 
 PLATFORMS
+  arm64-darwin-21
   x86_64-darwin-19
 
 DEPENDENCIES
@@ -68,7 +69,7 @@ DEPENDENCIES
   webrick
 
 RUBY VERSION
-   ruby 3.0.1p64
+   ruby 3.1.4p223
 
 BUNDLED WITH
    2.2.15

README.md

@@ -1,3 +1,53 @@
 # MLG Blog
 
-TBD
+This is the repository for the MLG blog. It is built using Jekyll and hosted on GitHub Pages.
+
+The blog is available at [https://mlg.eng.cam.ac.uk/blog](https://mlg.eng.cam.ac.uk/blog).
+
+## Installation: Prerequisites
+
+### Mac (Apple Silicon)
+
+There is a bug in the current version of Jekyll that prevents it from using the latest version of Ruby. To get around this, you need to install an older version of Ruby using Homebrew.
+
+```bash
+brew install [email protected]
+```
+
+In your `~/.zshrc` file, add the following line (pointing to the location of the Ruby binary installed by Homebrew):
+
+```bash
+export PATH="/opt/homebrew/opt/[email protected]/bin:$PATH"
+```
+
+Don't forget to source your `~/.zshrc` file.
+
+Test that you have the correct version of Ruby installed:
+
+```bash
+ruby -v
+```
+should output something like the above: `ruby 3.1.4p223 (2023-03-30 revision 957bb7cb81) [arm64-darwin21]`
+
+## Installation
+
+Prerequisites: Ruby (see above).
+
+After cloning the repository, `cd` into the directory and install the dependencies following the instructions below.
+
+Once the correct version of Ruby is installed, you can install Jekyll and Bundler. We need to specify the version of Bundler to install, otherwise it will install the latest version, which is incompatible with the version of Bundler that was used to build the lock file.
+```bash
+gem install jekyll bundler:2.2.15
+```
+
+Install the dependencies:
+
+```bash
+bundle install
+```
+
+Finally, run the server in development mode:
+
+```bash
+bundle exec jekyll serve --drafts
+```