Browse Source

Update docs for new brightray location

Kevin Sawicki 8 years ago
parent
commit
94eff35286

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

@@ -25,7 +25,7 @@ so you can use it for browser testing in place of [PhantomJS](http://phantomjs.o
 
 __2. Build System__
 
-In order to avoid the complexity of building all of Chromium, Electron uses [`libchromiumcontent`](https://github.com/brightray/libchromiumcontent) to access
+In order to avoid the complexity of building all of Chromium, Electron uses [`libchromiumcontent`](https://github.com/electron/libchromiumcontent) to access
 Chromium's Content API. `libchromiumcontent` is a single shared library that
 includes the Chromium Content module and all of its dependencies. Users don't
 need a powerful machine to build Electron.

+ 2 - 2
docs/development/build-system-overview.md

@@ -11,9 +11,9 @@ Following `gyp` files contain the main rules for building Electron:
 * `electron.gyp` defines how Electron itself is built.
 * `common.gypi` adjusts the build configurations of Node to make it build
   together with Chromium.
-* `vendor/brightray/brightray.gyp` defines how `brightray` is built and
+* `brightray/brightray.gyp` defines how `brightray` is built and
   includes the default configurations for linking with Chromium.
-* `vendor/brightray/brightray.gypi` includes general build configurations about
+* `brightray/brightray.gypi` includes general build configurations about
   building.
 
 ## Component Build

+ 1 - 1
docs/development/debug-instructions-windows.md

@@ -47,7 +47,7 @@ source code matches the code running in the attached process and break
 accordingly.
 
 Relevant code files can be found in `./atom/` as well as in Brightray, found in
-`./vendor/brightray/browser` and `./vendor/brightray/common`. If you're hardcore,
+`./brightray/browser` and `./brightray/common`. If you're hardcore,
 you can also debug Chromium directly, which is obviously found in `chromium_src`.
 
 ### Attaching

+ 4 - 4
docs/development/debugging-instructions-macos.md

@@ -18,8 +18,8 @@ to enable step-through debugging with breakpoints inside Electron's source code.
   tail calls, and other compiler optimizations.
 
 * **Xcode**: In addition to Xcode, also install the Xcode command line tools.
-  They include LLDB, the default debugger in Xcode on Mac OS X. It supports 
-  debugging C, Objective-C and C++ on the desktop and iOS devices and simulator. 
+  They include LLDB, the default debugger in Xcode on Mac OS X. It supports
+  debugging C, Objective-C and C++ on the desktop and iOS devices and simulator.
 
 ## Attaching to and Debugging Electron
 
@@ -40,7 +40,7 @@ that isn't behaving correctly - so you'd like to break on that command's C++
 counterpart inside the Electron source.
 
 Relevant code files can be found in `./atom/` as well as in Brightray, found in
-`./vendor/brightray/browser` and `./vendor/brightray/common`. If you're hardcore,
+`./brightray/browser` and `./brightray/common`. If you're hardcore,
 you can also debug Chromium directly, which is obviously found in `chromium_src`.
 
 Let's assume that you want to debug `app.setName()`, which is defined in `browser.cc`
@@ -77,7 +77,7 @@ Process 25244 stopped
 ```
 
 To show the arguments and local variables for the current frame, run `frame variable` (or `fr v`),
-which will show you that the app is currently setting the name to "Electron". 
+which will show you that the app is currently setting the name to "Electron".
 
 ```bash
 (lldb) frame variable

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

@@ -72,7 +72,7 @@ when running `git status`:
 ```sh
 $ git status
 
-	modified:   vendor/brightray (new commits)
+	modified:   vendor/libchromiumcontent (new commits)
 	modified:   vendor/node (new commits)
 ```
 

+ 0 - 2
docs/development/upgrading-chrome.md

@@ -19,8 +19,6 @@ Chrome/Node API changes.
 - Upgrade `vendor/depot_tools` for any build tools changes needed
 - Update the `libchromiumcontent` SHA-1 to download in `script/lib/config.py`
 - Open a pull request on `electron/libchromiumcontent` with the changes
-- Open a pull request on `electron/brightray` with the changes
-  - This should include upgrading the `vendor/libchromiumcontent` submodule
 - Open a pull request on `electron/electron` with the changes
   - This should include upgrading the submodules in `vendor/` as needed
 - Verify debug builds succeed on:

+ 2 - 5
docs/glossary.md

@@ -12,10 +12,8 @@ The ASAR format was created primarily to improve performance on Windows... TODO
 
 ### Brightray
 
-[Brightray][brightray] is a static library that makes [libchromiumcontent]
-easier to use in applications. It was created specifically for Electron, but can
-be used to enable Chromium's renderer in native apps that are not based on
-Electron.
+Brightray is a static library that makes [libchromiumcontent]
+easier to use in applications.
 
 Brightray is a low-level dependency of Electron that does not concern the
 majority of Electron users.
@@ -142,7 +140,6 @@ embedded content.
 [addons]: https://nodejs.org/api/addons.html
 [asar]: https://github.com/electron/asar
 [autoUpdater]: api/auto-updater.md
-[brightray]: https://github.com/electron/brightray
 [electron-builder]: https://github.com/electron-userland/electron-builder
 [libchromiumcontent]: #libchromiumcontent
 [Mac App Store Submission Guide]: tutorials/mac-app-store-submission-guide.md