Browse Source

Source code structure as tree command

Jessica Lord 9 years ago
parent
commit
889c982918
1 changed files with 36 additions and 33 deletions
  1. 36 33
      docs/development/source-code-directory-structure.md

+ 36 - 33
docs/development/source-code-directory-structure.md

@@ -9,39 +9,42 @@ to understand the source code better.
 
 ## Structure of Source Code
 
-* **atom** - Source code of Electron.
-  * **app** - System entry code.
-  * **browser** - The frontend including the main window, UI, and all of the
-    main process things. This talks to the renderer to manage web pages.
-    * **lib** - Javascript part of the main process 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 Electron is started
-      without providing an app.
-    * **api** - The implementation of the main process APIs.
-       * **lib** - Javascript part of the API implementation.
-    * **net** - Network related code.
-    * **mac** - Mac specific Objective-C source code.
-    * **resources** - Icons, platform-dependent files, etc.
-  * **renderer** - Code that runs in renderer process.
-    * **lib** - Javascript part of renderer initialization code.
-    * **api** - The implementation of renderer process APIs.
-       * **lib** - Javascript part of the API implementation.
-  * **common** - Code that used by both the main and renderer processes,
-    including some utility functions and code to integrate node's message
-    loop into Chromium's message loop.
-    * **lib** - Common Javascript initialization code.
-    * **api** - The implementation of common APIs, and foundations of
-    Electron's built-in modules.
-       * **lib** - Javascript part of the API implementation.
-* **chromium_src** - Source code that copied from Chromium.
-* **docs** - Documentations.
-* **spec** - Automatic tests.
-* **atom.gyp** - Building rules of Electron.
-* **common.gypi** - Compiler specific settings and building rules for other
-  components like `node` and `breakpad`.
+```
+Electron
+├──atom - Source code of Electron.
+|  ├── app - System entry code.
+|  ├── browser - The frontend including the main window, UI, and all of the
+|  |   main process things. This talks to the renderer to manage web pages.
+|  |   ├── lib - Javascript part of the main process 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 Electron is started
+|  |   |   without providing an app.
+|  |   ├── api - The implementation of the main process APIs.
+|  |   |   └── lib - Javascript part of the API implementation.
+|  |   ├── net - Network related code.
+|  |   ├── mac - Mac specific Objective-C source code.
+|  |   └── resources - Icons, platform-dependent files, etc.
+|  ├── renderer - Code that runs in renderer process.
+|  |   ├── lib - Javascript part of renderer initialization code.
+|  |   └── api - The implementation of renderer process APIs.
+|  |       └── lib - Javascript part of the API implementation.
+|  └── common - Code that used by both the main and renderer processes,
+|      including some utility functions and code to integrate node's message
+|      loop into Chromium's message loop.
+|      ├── lib - Common Javascript initialization code.
+|      └── api - The implementation of common APIs, and foundations of
+|          Electron's built-in modules.
+|          └── lib - Javascript part of the API implementation.
+├── chromium_src - Source code that copied from Chromium.
+├── docs - Documentations.
+├── spec - Automatic tests.
+├── atom.gyp - Building rules of Electron.
+└── common.gypi - Compiler specific settings and building rules for other
+    components like `node` and `breakpad`.
+```
 
 ## Structure of Other Directories