From 747f66bfe18003c55118398b94dd2c1255fbbb32 Mon Sep 17 00:00:00 2001 From: Tim Abbott Date: Tue, 17 Jan 2017 11:00:24 -0800 Subject: [PATCH] docs: Add README.md files for scripts/ and tools/. --- scripts/README.md | 12 ++++++++++++ tools/README.md | 8 ++++++++ 2 files changed, 20 insertions(+) create mode 100644 scripts/README.md create mode 100644 tools/README.md diff --git a/scripts/README.md b/scripts/README.md new file mode 100644 index 0000000000..10c1b3f5e4 --- /dev/null +++ b/scripts/README.md @@ -0,0 +1,12 @@ +This directory contains scripts that: + +* Generally do not require access to Django or the database (those are + "management commands"), and thus are suitable to run operationally. + +* Are useful for managing a production deployment of Zulip (many are + also used in a Zulip development environment, though + development-only scripts live in `tools/`). + +For more details, see +http://zulip.readthedocs.io/en/latest/directory-structure.html. + diff --git a/tools/README.md b/tools/README.md new file mode 100644 index 0000000000..fec9bafce4 --- /dev/null +++ b/tools/README.md @@ -0,0 +1,8 @@ +This directory contains scripts that are used in building, managing, +testing, and other forms of work in a Zulip development environment. +Note that tools that are also useful in production belong in +`scripts/` or should be Django management commands. + +For more details, see +http://zulip.readthedocs.io/en/latest/directory-structure.html. +