aboutsummaryrefslogtreecommitdiffstats
path: root/ORGANIZATION.md
diff options
context:
space:
mode:
authorJack Moffitt <jack@metajack.im>2014-08-28 09:34:23 -0600
committerJack Moffitt <jack@metajack.im>2014-09-08 20:21:42 -0600
commitc6ab60dbfc6da7b4f800c9e40893c8b58413960c (patch)
treed1d74076cf7fa20e4f77ec7cb82cae98b67362cb /ORGANIZATION.md
parentdb2f642c32fc5bed445bb6f2e45b0f6f0b4342cf (diff)
downloadservo-c6ab60dbfc6da7b4f800c9e40893c8b58413960c.tar.gz
servo-c6ab60dbfc6da7b4f800c9e40893c8b58413960c.zip
Cargoify servo
Diffstat (limited to 'ORGANIZATION.md')
-rw-r--r--ORGANIZATION.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/ORGANIZATION.md b/ORGANIZATION.md
new file mode 100644
index 00000000000..9e237010d5c
--- /dev/null
+++ b/ORGANIZATION.md
@@ -0,0 +1,40 @@
+# Servo code organization
+
+## Servo components
+
+* `src/bin.rs`: Servo's entry point
+* `src/lib.rs`: libservo entry point
+* `components/layout`: The layout system.
+* `components/style`: The CSS styling system.
+* `components/script`: The JavaScript and DOM systems.
+* `components/compositing`: The compositor and windowing systems.
+* `components/gfx`: Graphics rendering, fonts, and text shaping.
+* `components/net`: Networking, caching, image decoding.
+* `components/msg`: Message structure definitions for inter-task communication.
+* `components/*_traits`: Trait definitions to break crate dependencies.
+* `components/macros`: Macros used by the rest of Servo.
+* `components/util`: Various utility functions used by other Servo components.
+
+## Supporting libraries
+
+These libraries are either internal but used by Servo or external and need
+special integration:
+
+* `support/glfw-rs`: Wrapping for the GLFW library. Will eventually move to
+ being completely out of tree.
+* `support/rust-task_info`: A binding to the task_info library on OS X.
+
+## Tests
+
+* `tests/contenttest.rs`: Content (JavaScript) test runner
+* `tests/contenttest`: Content tests
+* `tests/reftest.rs`: Reference (layout) test runner
+* `tests/reftest`: Reference tests
+* `tests/html`: Manual test cases and examples
+* `tests/power`: Tests for measuring power usage
+* `tests/wpt`: Web platform tests and harness
+
+## Miscellaneous
+
+* `etc`: Various scripts and files that don't belong anywhere else.
+* `etc/patches`: Patches for upstream libraries.