From b2d4d76bcf3575c1d8e8161b903143a82b014d87 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 16 Jan 2014 10:31:59 +0800 Subject: [PATCH] :memo: Update docs on source code structure. --- docs/development/source-code-directory-structure.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/development/source-code-directory-structure.md b/docs/development/source-code-directory-structure.md index 3f46bf63029c..a583322b7a66 100644 --- a/docs/development/source-code-directory-structure.md +++ b/docs/development/source-code-directory-structure.md @@ -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`.