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

Standardize dir structure

Browse source
This commit is contained in:
Jessica Lord 2015-08-30 22:31:43 -07:00
parent 29c865f0e1
commit 2c79e9fd41
1 changed files with 6 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,15 +1,13 @@
# Source code directory structure # Source Code Directory Structure
## Overview The source code of Electron is separated into a few parts, mostly
The source code of Electron is separated into a few parts, and we are mostly
following Chromium on the separation conventions. following Chromium on the separation conventions.
You may need to become familiar with [Chromium's multi-process You may need to become familiar with [Chromium's multi-process
architecture](http://dev.chromium.org/developers/design-documents/multi-process-architecture) architecture](http://dev.chromium.org/developers/design-documents/multi-process-architecture)
to understand the source code better. to understand the source code better.
## Structure of source code ## Structure of Source Code
* **atom** - Source code of Electron. * **atom** - Source code of Electron.
* **app** - System entry code. * **app** - System entry code.
@ -45,18 +43,18 @@ to understand the source code better.
* **common.gypi** - Compiler specific settings and building rules for other * **common.gypi** - Compiler specific settings and building rules for other
components like `node` and `breakpad`. components like `node` and `breakpad`.
## Structure of other directories ## Structure of Other Directories
* **script** - Scripts used for development purpose like building, packaging, * **script** - Scripts used for development purpose like building, packaging,
testing, etc. testing, etc.
* **tools** - Helper scripts used by gyp files, unlike `script`, scripts put * **tools** - Helper scripts used by gyp files, unlike `script`, scripts put
here should never be invoked by users directly. here should never be invoked by users directly.
* **vendor** - Source code of third party dependencies, we didn't use * **vendor** - Source code of third party dependencies, we didn't use
`third_party` as name because it would confuse with the same directory in `third_party` as name because it would confuse it with the same directory in
Chromium's source code tree. Chromium's source code tree.
* **node_modules** - Third party node modules used for building. * **node_modules** - Third party node modules used for building.
* **out** - Temporary output directory of `ninja`. * **out** - Temporary output directory of `ninja`.
* **dist** - Temporary directory created by `script/create-dist.py` script * **dist** - Temporary directory created by `script/create-dist.py` script
when creating an distribution. when creating an distribution.
* **external_binaries** - Downloaded binaries of third-party frameworks which * **external_binaries** - Downloaded binaries of third-party frameworks which
do not support to be built via `gyp`. do not support building with `gyp`.