Browse Source

:memo: Update docs for new source code structure.

Cheng Zhao 11 years ago
parent
commit
eaab9b295b
1 changed files with 29 additions and 27 deletions
  1. 29 27
      docs/development/source-code-directory-structure.md

+ 29 - 27
docs/development/source-code-directory-structure.md

@@ -11,33 +11,35 @@ to understand the source code better.
 
 ## Structure of source code
 
-* **app** - Contains system entry code, this is the most basic level of the
-  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.
-    * **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.
-* **spec** - Automatic tests.
-* **script** - Scripts for building atom-shell.
+* **atom** - Source code of atom-shell.
+  * **app** - Contains system entry code, this is the most basic level of the
+    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.
+      * **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.
+  * **spec** - Automatic tests.
+  * **script** - Scripts for building atom-shell.
+* **chrome** - Source code modified from Chromium's chrome component.
 
 ## Structure of other directories