📝 Update docs on source code structure.

This commit is contained in:
Cheng Zhao 2014-01-16 10:31:59 +08:00
parent 9ac555c302
commit b2d4d76bcf

View file

@ -15,17 +15,24 @@ to understand the source code better.
program.
* **browser** - The frontend including the main window, UI, and all browser
side things. This talks to the renderer to manage web pages.
* **lib** - Javascript part of browser initialization code.
* **ui** - Implementation of UI stuff for different platforms.
* **atom** - Initializes the javascript environment of browser.
* **cocoa** - Cocoa specific source code.
* **gtk** - GTK+ specific source code.
* **win** - Windows GUI specific source code.
* **default_app** - The default page to show when atom-shell is started
without providing an app.
* **api** - The implementation of browser side APIs.
* **lib** - Javascript part of the API implementation.
* **net** - Network related code.
* **renderer** - Code that runs in renderer.
* **lib** - Javascript part of renderer initialization code.
* **api** - The implementation of renderer side APIs.
* **lib** - Javascript part of the API implementation.
* **common** - Code that used by both browser and renderer, including some
utility functions and code to integrate node's message loop into Chromium's message loop.
* **lib** - Common Javascript initialization code.
* **v8** - Utility functions for using V8 and node APIs.
* **api** - The implementation of common APIs, and foundations of
atom-shell's built-in modules.
* **lib** - Javascript part of the API implementation.
@ -35,7 +42,7 @@ to understand the source code better.
## Structure of other directories
* **vendor** - Build dependencies.
* **tools** - Helper scripts to build atom-shell.
* **tools** - Helper scripts used by gyp files.
* **node_modules** - Third party node modules used for building or running
specs.
* **out** - Output directory for `ninja`.