aboutsummaryrefslogtreecommitdiffstats
path: root/python
diff options
context:
space:
mode:
Diffstat (limited to 'python')
-rw-r--r--python/README.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/python/README.md b/python/README.md
new file mode 100644
index 00000000000..9e036852e42
--- /dev/null
+++ b/python/README.md
@@ -0,0 +1,41 @@
+This directory contains various Python modules used to support servo
+development.
+
+= mach =
+
+The command dispatch framework used to wrap the build system and test
+harnesses.
+
+= mozdebug =
+
+mozbase module containing information about various debuggers.
+
+This can be updated by copying the latest version from
+https://hg.mozilla.org/mozilla-central/file/tip/testing/mozbase/mozdebug
+
+= mozinfo =
+
+Mozbase module for extracting information about the host hardware /
+os.
+
+This can be updated by copying the latest version from
+hg.mozilla.org/mozilla-central/file/tip/testing/mozbase/mozinfo
+
+= mozlog =
+
+A mozbase logging module required for wptrunner output and command
+line arguments.
+
+This can be updated by copying the latest version from
+hg.mozilla.org/mozilla-central/file/tip/testing/mozbase/mozlog
+
+= servo =
+
+servo-specific python code e.g. implementations of mach commands. This
+is the canonical repository for this code.
+
+== toml ==
+
+Python module for reading toml files.
+
+This can be updated from https://github.com/uiri/toml