From 147fa198670f960f0e607adc6c699b079d925c54 Mon Sep 17 00:00:00 2001 From: Damiano Petrungaro Date: Wed, 4 Jul 2018 02:01:55 +0200 Subject: [PATCH] docs: Add docker-compose documentation --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index dfeeb6e..7ce1750 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,11 @@ to send a pull request. 4. Ensure all files have the appropriate `title` and `language` front matter (see others as an example). 5. Add the language to the `_config.yml` file. +### Running project locally + +There's a docker-compose.yml file ready that will help you to check if the website looks good! +To run it make sure you have [docker-compose installed](https://docs.docker.com/compose/install/#install-compose) on your machine and just use the command `docker-compose up` to make it run locally. + ## Badges! Tell your users that you use the Conventional Commits specification: