[CB-1759] fix up the doc
https://issues.apache.org/jira/browse/CB-1759
Started with a bug requiring a small change, blossomed
into a bit more general cleanup.
diff --git a/weinre.doc/ChangeLog.body.html b/weinre.doc/ChangeLog.body.html
index f1bd9b9..202d397 100644
--- a/weinre.doc/ChangeLog.body.html
+++ b/weinre.doc/ChangeLog.body.html
@@ -48,6 +48,7 @@
<li><a href="https://issues.apache.org/jira/browse/CB-873">CB-873</a> - setTimeout() and setInterval() usage with string arguments is busted
<li><a href="https://issues.apache.org/jira/browse/CB-984">CB-984</a> - cannot install weinre with Node 0.8.0
<li><a href="https://issues.apache.org/jira/browse/CB-1666">CB-1666</a> - "INVALID_STATE_ERR: DOM Exception 11" with chbrody/Cordova-SQLitePlugin
+<li><a href="https://issues.apache.org/jira/browse/CB-1759">CB-1759</a> - doc indicates that you should launch weinre with a command prefix of `node`
</ul>
<!-- ======================================================================= -->
diff --git a/weinre.doc/Home.body.html b/weinre.doc/Home.body.html
index 1edcae4..cb3cf6a 100644
--- a/weinre.doc/Home.body.html
+++ b/weinre.doc/Home.body.html
@@ -57,10 +57,10 @@
<td><a href="https://github.com/apache/incubator-cordova-weinre">https://github.com/apache/incubator-cordova-weinre</a>
<tr><td>mailing lists at Apache:
-<td><a href="http://incubator.apache.org/cordova/#mailing-list">http://incubator.apache.org/cordova/#mailing-list</a> (use callback-dev)
+<td><a href="http://incubator.apache.org/cordova/#mailing-list">http://incubator.apache.org/cordova/#mailing-list</a> (for weinre development)
<tr><td>discussion at Google Group:
-<td><a href="http://groups.google.com/group/weinre">http://groups.google.com/group/weinre</a>
+<td><a href="http://groups.google.com/group/weinre">http://groups.google.com/group/weinre</a> (for weinre usage)
</table>
diff --git a/weinre.doc/Installing.body.html b/weinre.doc/Installing.body.html
index d004010..3d635af 100644
--- a/weinre.doc/Installing.body.html
+++ b/weinre.doc/Installing.body.html
@@ -17,39 +17,50 @@
* under the License.
-->
-<p><span class="weinre">weinre</span> is shipped as binary packages
-available at Apache.
+<p><span class="weinre">weinre</span> is implemented as a
+<a href="http://nodejs.org/">node.js</a> application, and so you'll
+need to <a href="http://nodejs.org/download/">download and install
+a node runtime</a> to run <span class="weinre">weinre</span>.
-<p>To install <span class="weinre">weinre</span>, download a <tt>bin</tt> package, unarchive
-to wherever you'd wish. <span class="weinre">weinre</span> is not
-sensitive to the directory it's installed in, and does not
+<p>To install <span class="weinre">weinre</span>, use <tt>npm</tt>,
+or download a binary package. <span class="weinre">weinre</span> is not
+sensitive to the directory it's installed in, and does not
write to any files.
<!-- ======================================================================= -->
<h2>npm installation</h2>
-<p><span class="weinre">weinre</span> can be installed as an
+<p><span class="weinre">weinre</span> can be installed as an
<a href="http://npmjs.org/doc/README.html">npm package</a>. The
-<tt>*-bin.tar.gz</tt> urls/files can be used as a target of the
+<tt>*-bin.tar.gz</tt> urls/files for binary packages
+can be used as a target of the
<a href="http://npmjs.org/doc/install.html"><tt>npm install</tt></a>
-command. For example, use the following command to install
-<span class="weinre">weinre</span> locally, from this example URL:
+command.
+
+<p>It's likely you will want to install <span class="weinre">weinre</span>
+globally instead of locally (in the <tt>npm</tt> sense), which means you
+will typically want to use the <tt>npm -g</tt> option to install. For
+*ix and Mac, this also means prefixing your command with sudo. For Windows,
+AFAIK, you don't need sudo or any equivalent.
+
+<p>Here's an example of installing from a binary package via URL:
<pre>
-npm install http://example.com/path/to/apache-cordova-weinre-X.Y.Z-bin.tar.gz
+sudo npm -g install http://example.com/path/to/apache-cordova-weinre-X.Y.Z-bin.tar.gz
</pre>
-<p>weinre is also deployed on
-<a href="http://search.npmjs.org/#/weinre">http://search.npmjs.org/#/weinre</a>
+<p><span class="weinre">weinre</span> is also deployed on
+<a href="https://npmjs.org/package/weinre">https://npmjs.org/package/weinre</a>
so that you can install it via:
<pre>
-npm install weinre
+sudo npm -g install weinre
</pre>
<!-- ======================================================================= -->
<h2>Binary Packages</h2>
+<!--
<p>The recent source and binary release archives should be available at:
<ul>
@@ -65,6 +76,7 @@
<br><b><i>(at the time of this writing, that link does not actually resolve because
there are no official releases)</i></b>
</ul>
+-->
<p>Unofficial binary packages for your convenience:
diff --git a/weinre.doc/Running.body.html b/weinre.doc/Running.body.html
index 6c2f228..cc80795 100644
--- a/weinre.doc/Running.body.html
+++ b/weinre.doc/Running.body.html
@@ -62,15 +62,18 @@
to function as a <b>Debug Target</b>.
<!-- ======================================================== -->
-<h2>Running the debug server using the weinre-node distribution</h2>
+<h2>Running the debug server using an <tt>npm</tt> installation</h2>
-<p>To run <span class="weinre">weinre</span> from the weinre-node distribution,
-execute the following command:
+<p>To run <span class="weinre">weinre</span> from an <tt>npm</tt>
+installation, assuming you've installed it globally (in the <tt>npm</tt>
+sense), execute the following command:
<pre>
-node path-to-weinre-node/weinre [options]
+weinre [options]
</pre>
+<p>The server will run until you kill it. Control-C will do the job.
+
<p>Options available are:
<ul class="spaced no-bullet">
@@ -139,12 +142,18 @@
</ul>
+<!-- ======================================================== -->
+<h2>The <tt>~/.weinre/server.properties</tt> file</h2>
+
<p>You may also create a file named
<tt>server.properties</tt> in the
directory <tt>.weinre</tt> in your
home directory (eg.
<tt>~/.weinre/server.properties</tt>).
-The keys should be
+Your home directory is the determined by the value of either the
+<tt>HOME</tt> or <tt>USERPROFILE</tt> environment variable.
+
+<p>The keys should be
the same as the name of the options above,
with the same values.
@@ -162,8 +171,6 @@
<p>Command-line options override the options specified in the
<tt>~/.weinre/server.properties</tt> file.
-<p>The server will run until you kill it. Control-C will do the job.
-
<!-- ======================================================== -->
<h2>Running the debug server bound to something other than <tt>localhost</tt></h3>
diff --git a/weinre.doc/boilerplate-header.html.txt b/weinre.doc/boilerplate-header.html.txt
index e93d93b..b33bec7 100644
--- a/weinre.doc/boilerplate-header.html.txt
+++ b/weinre.doc/boilerplate-header.html.txt
@@ -28,9 +28,9 @@
<body>
-<!--
-<a class="no-decoration" href="https://git-wip-us.apache.org/repos/asf/incubator-cordova-weinre.git"><div class="ribbon">clone weinre at apache</div></a>
--->
+<div class="ribbon">clone weinre at
+<a href="https://git-wip-us.apache.org/repos/asf/incubator-cordova-weinre.git">apache</a>
+</div>
<!-- ======================================================================= -->
<h1 class="page-title">weinre - @PAGE_NAME@</h1>
diff --git a/weinre.doc/css/main.css b/weinre.doc/css/main.css
index 8e4078d..fa2db24 100644
--- a/weinre.doc/css/main.css
+++ b/weinre.doc/css/main.css
@@ -26,13 +26,13 @@
.ribbon {
position: absolute;
top: 0;
- left: 0;
- border-right: thin solid #000;
+ right: 0;
+ border-left: thin solid #000;
border-bottom: thin solid #000;
- -moz-border-radius-bottomright: 0.5em;
- -webkit-border-bottom-right-radius: 0.5em;
+ -moz-border-radius-bottomleft: 0.5em;
+ -webkit-border-bottom-left-radius: 0.5em;
padding: 0.25em 0.5em;
- background-color: #FF0;
+ background-color: #FF8;
font-style: italic;
-webkit-box-shadow: 5px 5px 15px #888;
-moz-box-shadow: 5px 5px 15px #888;
