From 043d83d1cadd5b5abfa418ac02773c7a979c611d Mon Sep 17 00:00:00 2001
From: Frederick Muriuki Muriithi
Date: Mon, 25 Apr 2022 07:23:46 +0300
Subject: docs: update documentation on checks

---
 README.org | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

(limited to 'README.org')

diff --git a/README.org b/README.org
index 6210c08..aef1a08 100644
--- a/README.org
+++ b/README.org
@@ -37,10 +37,19 @@ To launch a guix shell for development, do:
 
 to get an environment that is isolated from the rest of your system.
 
-*** Tests
+*** Checks
 
 Run tests with:
-
 #+BEGIN_SRC shell
   pytest
 #+END_SRC
+
+To run the linter over the code base, run:
+#+BEGIN_SRC shell
+  pylint tests quality_control qc_app
+#+END_SRC
+
+To check for correct type usage in the application, run:
+#+BEGIN_SRC shell
+  mypy --show-error-codes .
+#+END_SRC
-- 
cgit v1.2.3