From fba8257a33a14518c7491d459905858f4e0c2cfe Mon Sep 17 00:00:00 2001 From: Dunya Kirkali Date: Sat, 28 Sep 2024 22:57:33 +0200 Subject: [PATCH] Update README --- Makefile | 3 +++ README.md | 8 ++++++++ 2 files changed, 11 insertions(+) diff --git a/Makefile b/Makefile index 729acd4..ac8cff7 100644 --- a/Makefile +++ b/Makefile @@ -35,3 +35,6 @@ output: clean: rm -vrf output + +lint: + vale source/ diff --git a/README.md b/README.md index c567850..81045a4 100644 --- a/README.md +++ b/README.md @@ -68,6 +68,14 @@ In order to remove the generated files you can run: make clean ``` +### Linting + +letterpress comes with [vale](https://vale.sh/). Once you've installed vale on your machine you can run it with: + +```bash +make lint +``` + ## Structure The entry point of the book is [book.adoc](book.adoc).