From 6b73e0caff9673965df7a096c360ac336eb1cba0 Mon Sep 17 00:00:00 2001
From: Chris Knight <cknight1234@gmail.com>
Date: Fri, 8 May 2020 14:28:02 +0100
Subject: add tools/README.md (#4453)

---
 tools/README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 tools/README.md

(limited to 'tools')

diff --git a/tools/README.md b/tools/README.md
new file mode 100644
index 000000000..f8f93f0ec
--- /dev/null
+++ b/tools/README.md
@@ -0,0 +1,47 @@
+# Tools
+
+Documentation for various tooling in support of Deno development
+
+## docs.py
+
+This script is used to generate the API documentation for Deno. It can be useful
+to run locally to test the formatting of your changes to the documentation.
+
+If you would like to see how your JSDoc will be rendered after changing
+`cli/js/lib.deno.ns.d.ts`, you can run the following:
+
+First, make sure you have typedoc installed:
+
+```bash
+npm install typedoc --save-dev
+```
+
+Then run the doc generation tool:
+
+```bash
+./tools/docs.py
+```
+
+Output can be found in `./target/typedoc/index.html`
+
+## format.py
+
+This script will format the code (currently using prettier, yapf and rustfmt).
+It is a prerequisite to run this before code check in.
+
+To run formatting:
+
+```bash
+./tools/format.py
+```
+
+## lint.py
+
+This script will lint the code base (currently using eslint, pylint and clippy).
+It is a prerequisite to run this before code check in.
+
+To run linting:
+
+```bash
+./tools/lint.py
+```
-- 
cgit v1.2.3