:memo: Indicate directories in the Structure of Source Code section
authorAaron Ang <awz.ang@gmail.com>
Fri, 27 May 2016 22:22:47 +0000 (00:22 +0200)
committerAaron Ang <awz.ang@gmail.com>
Fri, 27 May 2016 22:22:47 +0000 (00:22 +0200)
[ci skip]

docs/development/source-code-directory-structure.md

index 9e3cfee..cc74fe6 100644 (file)
@@ -11,38 +11,38 @@ to understand the source code better.
 
 ```
 Electron
-├── atom - C++ source code.
-|   ├── app - System entry code.
-|   ├── browser - The frontend including the main window, UI, and all of the
+├── atom/ - C++ source code.
+|   ├── 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.
-|   |   ├── ui - Implementation of UI stuff for different platforms.
-|   |   |   ├── cocoa - Cocoa specific source code.
-|   |   |   ├── gtk - GTK+ specific source code.
-|   |   |   └── win - Windows GUI specific source code.
-|   |   ├── api - The implementation of the main process APIs.
-|   |   ├── net - Network related code.
-|   |   ├── mac - Mac specific Objective-C source code.
-|   |   └── resources - Icons, platform-dependent files, etc.
-|   ├── renderer - Code that runs in renderer process.
-|   |   └── api - The implementation of renderer process APIs.
-|   └── common - Code that used by both the main and renderer processes,
+|   |   ├── ui/ - Implementation of UI stuff for different platforms.
+|   |   |   ├── cocoa/ - Cocoa specific source code.
+|   |   |   ├── win/ - Windows GUI specific source code.
+|   |   |   └── x/ - X11 specific source code.
+|   |   ├── api/ - The implementation of the main process APIs.
+|   |   ├── net/ - Network related code.
+|   |   ├── mac/ - Mac specific Objective-C source code.
+|   |   └── resources/ - Icons, platform-dependent files, etc.
+|   ├── renderer/ - Code that runs in renderer process.
+|   |   └── api/ - The implementation of renderer process APIs.
+|   └── 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.
-|       └── api - The implementation of common APIs, and foundations of
+|       └── api/ - The implementation of common APIs, and foundations of
 |           Electron's built-in modules.
-├── chromium_src - Source code that copied from Chromium.
-├── default_app - The default page to show when Electron is started without
+├── chromium_src/ - Source code that copied from Chromium.
+├── default_app/ - The default page to show when Electron is started without
 |   providing an app.
-├── docs - Documentations.
-├── lib - JavaScript source code.
-|   ├── browser - Javascript main process initialization code.
-|   |   └── api - Javascript API implementation.
-|   ├── common - JavaScript used by both the main and renderer processes
-|   |   └── api - Javascript API implementation.
-|   └── renderer - Javascript renderer process initialization code.
-|       └── api - Javascript API implementation.
-├── spec - Automatic tests.
-├── atom.gyp - Building rules of Electron.
+├── docs/ - Documentations.
+├── lib/ - JavaScript source code.
+|   ├── browser/ - Javascript main process initialization code.
+|   |   └── api/ - Javascript API implementation.
+|   ├── common/ - JavaScript used by both the main and renderer processes
+|   |   └── api/ - Javascript API implementation.
+|   └── renderer/ - Javascript renderer process initialization code.
+|       └── api/ - Javascript API implementation.
+├── spec/ - Automatic tests.
+├── electron.gyp - Building rules of Electron.
 └── common.gypi - Compiler specific settings and building rules for other
     components like `node` and `breakpad`.
 ```