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

Merge pull request #4910 from atom/update-structure-doc

Browse source 
Update source tree docs for new layout
This commit is contained in:
Kevin Sawicki 2016-03-24 15:57:31 -07:00
commit 8ce1ca4590
1 changed files with 28 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

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