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

Merge pull request #5744 from aaronang/docs-improve-structure-of-source-code

Browse source 
📝 Indicate directories in the Structure of Source Code section
This commit is contained in:
Kevin Sawicki 2016-05-27 15:41:28 -07:00
commit 5deb86d6f9
1 changed files with 27 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
docs/development/source-code-directory-structure.md
View 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`.
```