mirrors/conventionalcommits.org
0
0
Fork 0
mirror of https://github.com/conventional-commits/conventionalcommits.org.git synced 2025-08-22 13:58:35 +00:00
Code

docs: Add docker-compose documentation

Browse Source
This commit is contained in:
Damiano Petrungaro 2018-07-04 02:01:55 +02:00
parent 32f6430a86
commit 147fa19867
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -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: