From 002721b9a1626ad0a9c710da073914d02647c52d Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Thu, 19 Sep 2019 15:51:36 +0200 Subject: [PATCH] Improve README, add more detailed workflow instructions --- README.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 14806ce..8777e91 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,25 @@ The official Minetest website, living at [www.minetest.net](https://www.minetest.net). -# Features +## Features -* Uses the [Bulma](https://bulma.io/) CSS framework. -* Uses modern Web design techniques: `rem` units, `hsl` colors. -* Responsive site and favicon. +- Uses the [Bulma](https://bulma.io/) CSS framework. +- Uses modern Web design techniques: `rem` units, `hsl` colors. +- Responsive site and favicon. -# Workflow +## Workflow This site uses the [Jekyll](https://jekyllrb.com) static site generator. -Use `jekyll serve` to automatically build the Jekyll site and serve it locally. -# License +- Ensure you have [Ruby](https://www.ruby-lang.org/) 2.4 or later installed. +- Install [Bundler](https://bundler.io/) by running `gem install bundler`. + - On Linux, use a Ruby version manager such as [rbenv](https://github.com/rbenv/rbenv) + to easily switch to any version and avoid permission issues. +- Install dependencies by running `bundle install`. +- Use `bundle exec jekyll serve` to automatically build the site + and serve it locally. + +## License Copyright © 2015-2019 Hugo Locurcio and contributors