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

📝 Update docs on source code structure.

Browse source
This commit is contained in:
Cheng Zhao 2014-01-16 10:31:59 +08:00
parent 9ac555c302
commit b2d4d76bcf
1 changed files with 9 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -15,17 +15,24 @@ to understand the source code better.
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.
* **ui** - Implementation of UI stuff for different platforms. * **ui** - Implementation of UI stuff for different platforms.
* **atom** - Initializes the javascript environment of browser. * **cocoa** - Cocoa specific source code.
* **gtk** - GTK+ specific source code.
* **win** - Windows GUI specific source code.
* **default_app** - The default page to show when atom-shell is started * **default_app** - The default page to show when atom-shell is started
without providing an app. without providing an app.
* **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.
* **renderer** - Code that runs in renderer. * **renderer** - Code that runs in renderer.
* **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.
* **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.
@ -35,7 +42,7 @@ to understand the source code better.
## Structure of other directories ## Structure of other directories
* **vendor** - Build dependencies. * **vendor** - Build dependencies.
* **tools** - Helper scripts to build atom-shell. * **tools** - Helper scripts used by gyp files.
* **node_modules** - Third party node modules used for building or running * **node_modules** - Third party node modules used for building or running
specs. specs.
* **out** - Output directory for `ninja`. * **out** - Output directory for `ninja`.