Skip to content

Commit

Permalink
Update README.md, enhance instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
michalspano committed Nov 8, 2023
1 parent 4bb2acf commit 6e28286
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 6e28286

Please sign in to comment.