Skip to content

Commit 94eff35

Browse files
committed
Update docs for new brightray location
1 parent 7ff6036 commit 94eff35

7 files changed

+11
-16
lines changed

docs/development/atom-shell-vs-node-webkit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ so you can use it for browser testing in place of [PhantomJS](http://phantomjs.o
2525

2626
__2. Build System__
2727

28-
In order to avoid the complexity of building all of Chromium, Electron uses [`libchromiumcontent`](https://github.com/brightray/libchromiumcontent) to access
28+
In order to avoid the complexity of building all of Chromium, Electron uses [`libchromiumcontent`](https://github.com/electron/libchromiumcontent) to access
2929
Chromium's Content API. `libchromiumcontent` is a single shared library that
3030
includes the Chromium Content module and all of its dependencies. Users don't
3131
need a powerful machine to build Electron.

docs/development/build-system-overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ Following `gyp` files contain the main rules for building Electron:
1111
* `electron.gyp` defines how Electron itself is built.
1212
* `common.gypi` adjusts the build configurations of Node to make it build
1313
together with Chromium.
14-
* `vendor/brightray/brightray.gyp` defines how `brightray` is built and
14+
* `brightray/brightray.gyp` defines how `brightray` is built and
1515
includes the default configurations for linking with Chromium.
16-
* `vendor/brightray/brightray.gypi` includes general build configurations about
16+
* `brightray/brightray.gypi` includes general build configurations about
1717
building.
1818

1919
## Component Build

docs/development/debug-instructions-windows.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ source code matches the code running in the attached process and break
4747
accordingly.
4848

4949
Relevant code files can be found in `./atom/` as well as in Brightray, found in
50-
`./vendor/brightray/browser` and `./vendor/brightray/common`. If you're hardcore,
50+
`./brightray/browser` and `./brightray/common`. If you're hardcore,
5151
you can also debug Chromium directly, which is obviously found in `chromium_src`.
5252

5353
### Attaching

docs/development/debugging-instructions-macos.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ to enable step-through debugging with breakpoints inside Electron's source code.
1818
tail calls, and other compiler optimizations.
1919

2020
* **Xcode**: In addition to Xcode, also install the Xcode command line tools.
21-
They include LLDB, the default debugger in Xcode on Mac OS X. It supports
22-
debugging C, Objective-C and C++ on the desktop and iOS devices and simulator.
21+
They include LLDB, the default debugger in Xcode on Mac OS X. It supports
22+
debugging C, Objective-C and C++ on the desktop and iOS devices and simulator.
2323

2424
## Attaching to and Debugging Electron
2525

@@ -40,7 +40,7 @@ that isn't behaving correctly - so you'd like to break on that command's C++
4040
counterpart inside the Electron source.
4141

4242
Relevant code files can be found in `./atom/` as well as in Brightray, found in
43-
`./vendor/brightray/browser` and `./vendor/brightray/common`. If you're hardcore,
43+
`./brightray/browser` and `./brightray/common`. If you're hardcore,
4444
you can also debug Chromium directly, which is obviously found in `chromium_src`.
4545

4646
Let's assume that you want to debug `app.setName()`, which is defined in `browser.cc`
@@ -77,7 +77,7 @@ Process 25244 stopped
7777
```
7878
7979
To show the arguments and local variables for the current frame, run `frame variable` (or `fr v`),
80-
which will show you that the app is currently setting the name to "Electron".
80+
which will show you that the app is currently setting the name to "Electron".
8181
8282
```bash
8383
(lldb) frame variable

docs/development/source-code-directory-structure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ when running `git status`:
7272
```sh
7373
$ git status
7474

75-
modified: vendor/brightray (new commits)
75+
modified: vendor/libchromiumcontent (new commits)
7676
modified: vendor/node (new commits)
7777
```
7878

docs/development/upgrading-chrome.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@ Chrome/Node API changes.
1919
- Upgrade `vendor/depot_tools` for any build tools changes needed
2020
- Update the `libchromiumcontent` SHA-1 to download in `script/lib/config.py`
2121
- Open a pull request on `electron/libchromiumcontent` with the changes
22-
- Open a pull request on `electron/brightray` with the changes
23-
- This should include upgrading the `vendor/libchromiumcontent` submodule
2422
- Open a pull request on `electron/electron` with the changes
2523
- This should include upgrading the submodules in `vendor/` as needed
2624
- Verify debug builds succeed on:

docs/glossary.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,8 @@ The ASAR format was created primarily to improve performance on Windows... TODO
1212

1313
### Brightray
1414

15-
[Brightray][brightray] is a static library that makes [libchromiumcontent]
16-
easier to use in applications. It was created specifically for Electron, but can
17-
be used to enable Chromium's renderer in native apps that are not based on
18-
Electron.
15+
Brightray is a static library that makes [libchromiumcontent]
16+
easier to use in applications.
1917

2018
Brightray is a low-level dependency of Electron that does not concern the
2119
majority of Electron users.
@@ -142,7 +140,6 @@ embedded content.
142140
[addons]: https://nodejs.org/api/addons.html
143141
[asar]: https://github.com/electron/asar
144142
[autoUpdater]: api/auto-updater.md
145-
[brightray]: https://github.com/electron/brightray
146143
[electron-builder]: https://github.com/electron-userland/electron-builder
147144
[libchromiumcontent]: #libchromiumcontent
148145
[Mac App Store Submission Guide]: tutorials/mac-app-store-submission-guide.md

0 commit comments

Comments
 (0)