OLD | NEW |
1 # DOM Distiller | 1 # DOM Distiller |
2 | 2 |
3 DOM Distiller aims to provide a better reading experience by distilling the | 3 DOM Distiller aims to provide a better reading experience by distilling the |
4 content of the page. This distilled content can then be used in a variety of | 4 content of the page. This distilled content can then be used in a variety of |
5 ways. | 5 ways. |
6 | 6 |
7 The current efforts that will be powered by DOM Distiller: | 7 The current efforts that will be powered by DOM Distiller: |
8 - Reader mode: a mobile-friendly viewing mode for Chrome mobile | 8 - Reader mode: a mobile-friendly viewing mode for Chrome mobile |
9 | 9 |
10 ## How to use Reader mode on mobile Chrome | 10 ## How to use Reader mode on mobile Chrome |
(...skipping 26 matching lines...) Expand all Loading... |
37 Before you build for the first time, you need to install the build dependencies. | 37 Before you build for the first time, you need to install the build dependencies. |
38 | 38 |
39 For all platforms, it is require to download and install | 39 For all platforms, it is require to download and install |
40 [Google Chrome browser](https://www.google.com/chrome/browser/desktop/). | 40 [Google Chrome browser](https://www.google.com/chrome/browser/desktop/). |
41 | 41 |
42 ChromeDriver requires Google Chrome to be installed at a specific location | 42 ChromeDriver requires Google Chrome to be installed at a specific location |
43 (the default location for the platform). See | 43 (the default location for the platform). See |
44 [ChromeDriver documentation](https://code.google.com/p/selenium/wiki/ChromeDrive
r) | 44 [ChromeDriver documentation](https://code.google.com/p/selenium/wiki/ChromeDrive
r) |
45 for details. | 45 for details. |
46 | 46 |
47 ## Developing on Linux | 47 ## Developing on Ubuntu/Debian |
48 | 48 |
49 Install the dependencies by entering the `dom-distiller` folder and running: | 49 Install the dependencies by entering the `dom-distiller` folder and running: |
50 ```bash | 50 ```bash |
51 sudo ./install-build-deps.sh | 51 sudo ./install-build-deps.sh |
52 ``` | 52 ``` |
53 | 53 |
| 54 Ubuntu 14.04 64-bit is recommended. |
| 55 |
54 ## Developing on Mac OS X | 56 ## Developing on Mac OS X |
55 | 57 |
56 - Install JDK 7 using either your organizations software management tool, | 58 - Install JDK 7 using either your organizations software management tool, |
57 or download it from | 59 or download it from |
58 [Oracle](http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-
1880260.html). | 60 [Oracle](http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-
1880260.html). |
59 - Install [Homebrew](http://brew.sh/). | 61 - Install [Homebrew](http://brew.sh/). |
60 - Install `ant` and `python` using Homebrew: | 62 - Install `ant` and `python` using Homebrew: |
61 ```bash | 63 ```bash |
62 brew install ant python | 64 brew install ant python |
63 ``` | 65 ``` |
(...skipping 14 matching lines...) Expand all Loading... |
78 - Install `selenium` using `pip`: | 80 - Install `selenium` using `pip`: |
79 ``` | 81 ``` |
80 pip install --user selenium | 82 pip install --user selenium |
81 ``` | 83 ``` |
82 | 84 |
83 For the rest of this guide, there are sometimes references to a tool called | 85 For the rest of this guide, there are sometimes references to a tool called |
84 `xvfb` and specifically when running shell commands using `xvfb-run`. When you | 86 `xvfb` and specifically when running shell commands using `xvfb-run`. When you |
85 develop using a Mac OS X, you can remove that part of the command. For example | 87 develop using a Mac OS X, you can remove that part of the command. For example |
86 `xvfb-run echo` would just become `echo`. | 88 `xvfb-run echo` would just become `echo`. |
87 | 89 |
| 90 ## Developing with Vagrant |
| 91 |
| 92 This option could be useful if you want to develop on an unsupported system |
| 93 like Windows or Red Hat Linux. Even if you are on a supported system but |
| 94 would rather not touch the system too much, Vagrant is a viable alternative. |
| 95 |
| 96 The Vagrant VM is based on Ubuntu 14.04. |
| 97 |
| 98 - [Install Vagrant](http://www.vagrantup.com/downloads.html) on your system. |
| 99 Version 1.7.2 or higher is recommended. |
| 100 - Launch the Vagrant VM instance |
| 101 ```bash |
| 102 vagrant up |
| 103 ``` |
| 104 - SSH to the VM |
| 105 ```bash |
| 106 vagrant ssh |
| 107 ``` |
| 108 |
88 ## Tools for contributing | 109 ## Tools for contributing |
89 | 110 |
90 The DOM Distiller project uses the Chromium tools for collaboration. For code | 111 The DOM Distiller project uses the Chromium tools for collaboration. For code |
91 reviews, the | 112 reviews, the |
92 [Chromium Rietveld code review tool](https://codereview.chromium.org/) is used | 113 [Chromium Rietveld code review tool](https://codereview.chromium.org/) is used |
93 and the set of tools found in `depot_tools` is also required. | 114 and the set of tools found in `depot_tools` is also required. |
94 | 115 |
95 To get `depot_tools`, follow the guide at | 116 To get `depot_tools`, follow the guide at |
96 [Chrome infrastructure documentation for depot_tools](http://commondatastorage.g
oogleapis.com/chrome-infra-docs/flat/depot_tools/docs/html/depot_tools_tutorial.
html#_setting_up). | 117 [Chrome infrastructure documentation for depot_tools](http://commondatastorage.g
oogleapis.com/chrome-infra-docs/flat/depot_tools/docs/html/depot_tools_tutorial.
html#_setting_up). |
97 | 118 |
(...skipping 268 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
366 If you want you can copy some of these User-Agent aliases into normal bash | 387 If you want you can copy some of these User-Agent aliases into normal bash |
367 aliases for easy access later. For example, Nexus 4 would be: | 388 aliases for easy access later. For example, Nexus 4 would be: |
368 ```bash | 389 ```bash |
369 --user-agent="Mozilla/5.0 (Linux; Android 4.2.1; en-us; Nexus 4 Build/JOP40D) Ap
pleWebKit/535.19 (KHTML, like Gecko) Chrome/18.0.1025.166 Mobile Safari/535.19" | 390 --user-agent="Mozilla/5.0 (Linux; Android 4.2.1; en-us; Nexus 4 Build/JOP40D) Ap
pleWebKit/535.19 (KHTML, like Gecko) Chrome/18.0.1025.166 Mobile Safari/535.19" |
370 ``` | 391 ``` |
371 | 392 |
372 Steps 1-3 in the guide above can typically be done in a stable version of | 393 Steps 1-3 in the guide above can typically be done in a stable version of |
373 Chrome, whereas the rest of the steps is typically done in your own build of | 394 Chrome, whereas the rest of the steps is typically done in your own build of |
374 Chrome (hence the "(Re)" in step 4). Besides speed, this also facilitates | 395 Chrome (hence the "(Re)" in step 4). Besides speed, this also facilitates |
375 side-by-side comparison. | 396 side-by-side comparison. |
OLD | NEW |