mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

Source code structure as tree command

Browse source
This commit is contained in:
Jessica Lord 2015-08-31 21:49:05 -07:00
parent 691d8dd9ab
commit 889c982918
1 changed files with 36 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

69
docs/development/source-code-directory-structure.md
View file

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