Add a README file to src explaining the directories there

This commit is contained in:
Brian Anderson 2012-12-05 17:33:06 -08:00
parent f4f0612dbf
commit ecf2489083

51
src/README.md Normal file
View file

@ -0,0 +1,51 @@
Descriptions of the Servo source directories. For the most part these represent a single
crate or library.
## Servo and Rust projects
These are the main servo projects, as well as projects that are pure Rust (not bindings).
* _rust-css_ - A CSS parsing and selector matching library, based on libcss and currently
using libcss for the implementation, but not exposing any libcss internals
* _rust-geom_ - Generic math library
* _rust-http-client_ - An HTTP library in Rust, using libuv via the Rust standard library
* _rust-io-surface_ - OS X implementation of cross-process surface sharing. Used by sharegl
* _rust-layers_ - A simple scene graph
* _servo_ - The Servo web browser engine
* _servo-gfx_ - Servo's graphics subsystem
* _sharegl_ - A library for sharing drawing surfaces between processes
## Bindings
* _libcss_ - The CSS library from the NetSurf web browser. We are using this for parsing
and selector matching until we have a Rust solution
* _libhubbub_ - The HTML parser from the NetSurf web brsower. We are using this for parsing
until we have a Rust solution
* _libparserutils_ - A parsing library used by libcss and libhubbub
* _libwapcaplet_ - A string internment library used by libcss and libhubbub
* _mozjs_ - SpiderMonkey, forked from mozilla-central
* _rust-azure_ - mozilla-central's graphics abstraction layer and bindings
* _rust-cairo_ - Bindings to the cairo drawing library
* _rust-cocoa_ - Bindings to OS X's Cocoa framework
* _rust-core-foundation_ - Bindings to OS X's Core Foundation framework
* _rust-core-graphics_ - Bindings to OS X's Core Graphics framework
* _rust-core-text_ - Bindings to OS X's Core Text framework
* _rust-fontconfig_ - Bindings to fontconfig
* _rust-freetype_ - Bindings to FreeType
* _rust-glut_ - Bindings to GLUT
* _rust-harfbuzz_ - The harfbuzz text shaping library and bindings
* _rust-hubbub_ - Bindings to libhubbub
* _rust-mozjs_ - Bindings to SpiderMonkey
* _rust-netsurfcss_ - Bindings to libcss
* _rust-opengles_ - Bindings to OpenGL ES
* _rust-stb-image_ - The stb-image library and bindings
* _rust-wapcaplet_ - Bindings to libwapcaplet
* _rust-xlib_ - Bindings to xlib
* _skia_ - The Skia drawing library
## Other
* _contenttest_ - Test harness for JavaScript bindings
* _etc_ - Miscellaneous
* _reftest_ - Test harness for comparing Servo output to Firefox
* _test_ - Test cases