Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(1207)

Unified Diff: headless/README.md

Issue 2677033003: headless: Add a small C++ example application (Closed)
Patch Set: Rebased Created 3 years, 10 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « headless/BUILD.gn ('k') | headless/app/headless_example.cc » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: headless/README.md
diff --git a/headless/README.md b/headless/README.md
index bf4d30149cfd9885fcc7415769619b36b13c4d37..7886871c7b433c2bd48086d6acc2cb56615347cd 100644
--- a/headless/README.md
+++ b/headless/README.md
@@ -30,8 +30,10 @@ application. This approach is otherwise similar to controlling the browser over
a DevTools connection, but it provides more customization points, e.g., for
networking and [mojo services](https://docs.google.com/document/d/1Fr6_DJH6OK9rG3-ibMvRPTNnHsAXPk0VzxxiuJDSK3M/edit#heading=h.qh0udvlk963d).
-Headless Shell is a sample application which demonstrates the use of the
-headless C++ API. To run it, first initialize a headless build configuration:
+[Headless Example](https://cs.chromium.org/chromium/src/headless/app/headless_example.cc)
+is a small sample application which demonstrates the use of the headless C++
+API. It loads a web page and outputs the resulting DOM. To run it, first
+initialize a headless build configuration:
```
$ mkdir -p out/Debug
@@ -39,22 +41,26 @@ $ echo 'import("//build/args/headless.gn")' > out/Debug/args.gn
$ gn gen out/Debug
```
-Then build the shell:
+Then build the example:
```
-$ ninja -C out/Debug headless_shell
+$ ninja -C out/Debug headless_example
```
-After the build completes, Headless Shell can be run with the following command:
+After the build completes, the example can be run with the following command:
```
-$ out/Debug/headless_shell https://www.google.com
+$ out/Debug/headless_example https://www.google.com
```
-To attach a [DevTools](https://developer.chrome.com/devtools) debugger to the
-shell, start it with an argument specifying the debugging port:
+[Headless Shell](https://cs.chromium.org/chromium/src/headless/app/headless_shell.cc)
+is a more capable headless application. For instance, it supports remote
+debugging with the [DevTools](https://developer.chrome.com/devtools) protocol.
+To do this, start the application with an argument specifying the debugging
+port:
```
+$ ninja -C out/Debug headless_shell
$ out/Debug/headless_shell --remote-debugging-port=9222 https://youtube.com
```
« no previous file with comments | « headless/BUILD.gn ('k') | headless/app/headless_example.cc » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698