docs: Add README.md files for scripts/ and tools/.

This commit is contained in:
Tim Abbott 2017-01-17 11:00:24 -08:00
parent c0fdc451a0
commit 747f66bfe1
2 changed files with 20 additions and 0 deletions

12
scripts/README.md Normal file
View File

@ -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.

8
tools/README.md Normal file
View File

@ -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.