Cleanup docs
authorPlusb Preco <plusb21@gmail.com>
Sun, 28 Feb 2016 16:38:32 +0000 (01:38 +0900)
committerPlusb Preco <plusb21@gmail.com>
Sun, 28 Feb 2016 16:38:32 +0000 (01:38 +0900)
* Adjust 80 chars per line
* Line feed after header

docs/tutorial/testing-on-headless-ci.md

index 6b0dacf788f413617f74e65e03b5927469395db6..ec1f4635c9060847b88b4d797496431c3ce663ce 100644 (file)
@@ -1,11 +1,27 @@
 # Testing Electron with headless CI Systems (Travis CI, Jenkins)
 
-Being based on Chromium, Electron requires a display driver to function. If Chromium can't find a display driver, Electron will simply fail to launch - and therefore not executing any of your tests, regardless of how you are running them. Testing Electron-based apps on Travis, Circle, Jenkins or similar systems requires therefore a little bit of configuration. In essence, we need to use a virtual display driver.
+Being based on Chromium, Electron requires a display driver to function.
+If Chromium can't find a display driver, Electron will simply fail to launch -
+and therefore not executing any of your tests, regardless of how you are running
+them. Testing Electron-based apps on Travis, Circle, Jenkins or similar Systems
+requires therefore a little bit of configuration. In essence, we need to use
+a virtual display driver.
 
 ## Configuring the Virtual Display Server
-First, install [Xvfb](https://en.wikipedia.org/wiki/Xvfb). It's a virtual framebuffer, implementing the X11 display server protocol - it performs all graphical operations in memory without showing any screen output, which is exactly what we need.
 
-Then, create a virtual xvfb screen and export an environment variable called DISPLAY that points to it. Chromium in Electron will automatically look for `$DISPLAY`, so no further configuration of your app is required. This step can be automated with Paul Betts's [xfvb-maybe](https://github.com/paulcbetts/xvfb-maybe): Prepend your test commands with `xfvb-maybe` and the little tool will automatically configure xfvb, if required by the current system. On Windows or Mac OS X, it will simply do nothing. 
+First, install [Xvfb](https://en.wikipedia.org/wiki/Xvfb).
+It's a virtual framebuffer, implementing the X11 display server protocol -
+it performs all graphical operations in memory without showing any screen output,
+which is exactly what we need.
+
+Then, create a virtual xvfb screen and export an environment variable
+called DISPLAY that points to it. Chromium in Electron will automatically look
+for `$DISPLAY`, so no further configuration of your app is required.
+This step can be automated with Paul Betts's
+[xfvb-maybe](https://github.com/paulcbetts/xvfb-maybe): Prepend your test
+commands with `xfvb-maybe` and the little tool will automatically configure
+xfvb, if required by the current system. On Windows or Mac OS X, it will simply
+do nothing.
 
 ```
 ## On Windows or OS X, this just invokes electron-mocha
@@ -15,6 +31,7 @@ xvfb-maybe electron-mocha ./test/*.js
 ```
 
 ### Travis CI
+
 On Travis, your `.travis.yml` should look roughly like this:
 
 ```
@@ -29,10 +46,15 @@ install:
 ```
 
 ### Jenkins
+
 For Jenkins, a [Xfvb plugin is available](https://wiki.jenkins-ci.org/display/JENKINS/Xvfb+Plugin).
 
 ### Circle CI
-Circle CI is awesome and has xvfb and `$DISPLAY` [already setup, so no further configuration is required](https://circleci.com/docs/environment#browsers).
+
+Circle CI is awesome and has xvfb and `$DISPLAY`
+[already setup, so no further configuration is required](https://circleci.com/docs/environment#browsers).
 
 ### AppVeyor
-AppVeyor runs on Windows, supporting Selenium, Chromium, Electron and similar tools out of the box - no configuration is required.
+
+AppVeyor runs on Windows, supporting Selenium, Chromium, Electron and similar
+tools out of the box - no configuration is required.