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

📝 Update docs for new source code structure.

Browse source
This commit is contained in:
Cheng Zhao 2014-03-16 09:17:45 +08:00
parent b1f4a47b5b
commit eaab9b295b
1 changed files with 29 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -11,9 +11,10 @@ to understand the source code better.
## Structure of source code ## Structure of source code
* **app** - Contains system entry code, this is the most basic level of the * **atom** - Source code of atom-shell.
* **app** - Contains system entry code, this is the most basic level of the
program. program.
* **browser** - The frontend including the main window, UI, and all browser * **browser** - The frontend including the main window, UI, and all browser
side things. This talks to the renderer to manage web pages. side things. This talks to the renderer to manage web pages.
* **lib** - Javascript part of browser initialization code. * **lib** - Javascript part of browser initialization code.
* **ui** - Implementation of UI stuff for different platforms. * **ui** - Implementation of UI stuff for different platforms.
@ -25,19 +26,20 @@ to understand the source code better.
* **api** - The implementation of browser side APIs. * **api** - The implementation of browser side APIs.
* **lib** - Javascript part of the API implementation. * **lib** - Javascript part of the API implementation.
* **net** - Network related code. * **net** - Network related code.
* **renderer** - Code that runs in renderer. * **renderer** - Code that runs in renderer.
* **lib** - Javascript part of renderer initialization code. * **lib** - Javascript part of renderer initialization code.
* **api** - The implementation of renderer side APIs. * **api** - The implementation of renderer side APIs.
* **lib** - Javascript part of the API implementation. * **lib** - Javascript part of the API implementation.
* **common** - Code that used by both browser and renderer, including some * **common** - Code that used by both browser and renderer, including some
utility functions and code to integrate node's message loop into Chromium's message loop. utility functions and code to integrate node's message loop into Chromium's message loop.
* **lib** - Common Javascript initialization code. * **lib** - Common Javascript initialization code.
* **v8** - Utility functions for using V8 and node APIs. * **v8** - Utility functions for using V8 and node APIs.
* **api** - The implementation of common APIs, and foundations of * **api** - The implementation of common APIs, and foundations of
atom-shell's built-in modules. atom-shell's built-in modules.
* **lib** - Javascript part of the API implementation. * **lib** - Javascript part of the API implementation.
* **spec** - Automatic tests. * **spec** - Automatic tests.
* **script** - Scripts for building atom-shell. * **script** - Scripts for building atom-shell.
* **chrome** - Source code modified from Chromium's chrome component.
## Structure of other directories ## Structure of other directories