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

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

@ -11,33 +11,35 @@ 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.
program. * **app** - Contains system entry code, this is the most basic level of the
* **browser** - The frontend including the main window, UI, and all browser program.
side things. This talks to the renderer to manage web pages. * **browser** - The frontend including the main window, UI, and all browser
* **lib** - Javascript part of browser initialization code. side things. This talks to the renderer to manage web pages.
* **ui** - Implementation of UI stuff for different platforms. * **lib** - Javascript part of browser initialization code.
* **cocoa** - Cocoa specific source code. * **ui** - Implementation of UI stuff for different platforms.
* **gtk** - GTK+ specific source code. * **cocoa** - Cocoa specific source code.
* **win** - Windows GUI specific source code. * **gtk** - GTK+ specific source code.
* **default_app** - The default page to show when atom-shell is started * **win** - Windows GUI specific source code.
without providing an app. * **default_app** - The default page to show when atom-shell is started
* **api** - The implementation of browser side APIs. without providing an app.
* **lib** - Javascript part of the API implementation. * **api** - The implementation of browser side APIs.
* **net** - Network related code. * **lib** - Javascript part of the API implementation.
* **renderer** - Code that runs in renderer. * **net** - Network related code.
* **lib** - Javascript part of renderer initialization code. * **renderer** - Code that runs in renderer.
* **api** - The implementation of renderer side APIs. * **lib** - Javascript part of renderer initialization code.
* **lib** - Javascript part of the API implementation. * **api** - The implementation of renderer side APIs.
* **common** - Code that used by both browser and renderer, including some * **lib** - Javascript part of the API implementation.
utility functions and code to integrate node's message loop into Chromium's message loop. * **common** - Code that used by both browser and renderer, including some
* **lib** - Common Javascript initialization code. utility functions and code to integrate node's message loop into Chromium's message loop.
* **v8** - Utility functions for using V8 and node APIs. * **lib** - Common Javascript initialization code.
* **api** - The implementation of common APIs, and foundations of * **v8** - Utility functions for using V8 and node APIs.
atom-shell's built-in modules. * **api** - The implementation of common APIs, and foundations of
* **lib** - Javascript part of the API implementation. atom-shell's built-in modules.
* **spec** - Automatic tests. * **lib** - Javascript part of the API implementation.
* **script** - Scripts for building atom-shell. * **spec** - Automatic tests.
* **script** - Scripts for building atom-shell.
* **chrome** - Source code modified from Chromium's chrome component.
## Structure of other directories ## Structure of other directories