diff --git a/README.md b/README.md new file mode 100644 index 0000000..a13cb2d --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ + +# Sw/eden APT Site + +## Install + +Next you need to install `jekyll` Follow the guide here: https://jekyllrb.com/docs/installation + +### Gems + +Next, run `bundle install` to install all ruby gems needed. + +```bash +bundle install --path vendor/bundle +``` + +### Build and run the site! + +now you can build the site with this command + +```bash +bundle exec jekyll serve +``` diff --git a/_config.yml b/_config.yml index d3f314c..5fad4e2 100644 --- a/_config.yml +++ b/_config.yml @@ -63,3 +63,4 @@ exclude: - package-lock.json - vendor - node_modules + - README.md