From 6e28286bc2f5335b248c9d3b33aa15a2686f83cf Mon Sep 17 00:00:00 2001 From: michalspano Date: Wed, 8 Nov 2023 22:57:05 +0100 Subject: [PATCH] Update `README.md`, enhance instructions --- README.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 10d6e4f..a33db2b 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,19 @@ -README +## SKIP @ 🌐 +Instructions for **local development**. Make sure to install `jekyll` according +to [instructions](https://jekyllrb.com/docs/installation/). -In order to run locally, make sure to install jekyll according to instructions https://jekyllrb.com/docs/installation/ +### Install dependencies -run +```sh +$ bundle install +``` -`bundle install` +### Run (local level) -followed by +```sh +$ bundle exec jekyll serve --config "_config.yml,_config_local.yml"` +``` -`bundle exec jekyll serve --config "_config.yml,_config_local.yml"` - -The _config_local.yml file overrides the url, and makes it so the website is served locally. +The `_config_local.yml` file overrides the url, and makes it so the website is +served locally.