From 2c24fe5532903fcb45a7c79b91975df20424658f Mon Sep 17 00:00:00 2001
From: KernelDeimos <eric.alex.dube@gmail.com>
Date: Fri, 6 Dec 2024 11:39:07 -0500
Subject: [PATCH] doc: document tools directory (README.md)

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

diff --git a/tools/README.md b/tools/README.md
new file mode 100644
index 00000000..e74f2f05
--- /dev/null
+++ b/tools/README.md
@@ -0,0 +1,53 @@
+# Tools Directory
+
+This directory contains tools for developing and running puter.
+Each directory inside `/tools` is an npm workspace, so it can have its own
+package.json file and dependencies.
+
+## Scripts
+
+### `run-selfhosted.js`
+
+This is the main script for running a local instance of Puter.
+It verifies the version of node.js you are running and attempts to explain
+any errors that come up if initiating boot fails.
+
+Puter is booted with essential modules, and modules required for local
+file storage.
+
+### `gen-release-notes.js`
+
+Generates release notes between a hard-coded pair of versions. These versions
+need to be modified manually in the script source before running.
+
+### `check-translations.js`
+
+Checks for missing translations in `src/gui/src/i18n/translations`
+
+## Utilities
+
+### `comment-writer`
+
+Generates comments in source files using generative AI via Puter's AI drivers.
+
+To use this:
+- `cd` into the `tools/comment-writer` directory
+- Edit `config.json` and replace `auth_token` with your own
+- Run with a specified direcotry; for example:
+  `node main.js ../../src/backend/services`
+
+### `module-docgen`
+
+Document a module.
+
+## Libraries
+
+### comment-parser
+
+This is a package used by the `license-headers` tool to process existing
+comments.
+
+### file-walker
+
+This is used by `license-headers` and `comment-writer` to walk through
+source files.