Skip to content
This repository has been archived by the owner. It is now read-only.
Permalink
Browse files
the README.md in the weinre-node distribution is bogus

For some reason, the node_modules in weinre.server got munged.  A fresh
`npm install` got everything fixed up, but apparently auto-updated
formidable.  That's not great.  Presumably it updated due to a
"use version >= x.y.z" in one of weinre's (recursive) pre-reqs.

Beyond that, did some README.md fix ups.

Also changed the `weinre` command to load coffee-script via an
explicit path; this might not be needed (the package.json file
for coffeescript was munged, but then fixed later).
  • Loading branch information
pmuellr committed Feb 17, 2012
1 parent 528092d commit 5b95d39c91a53dd369672b2b6e0ed914012c3593
Showing 21 changed files with 198 additions and 311 deletions.
@@ -50,8 +50,8 @@ building weinre
---------------

The weinre build is currently run on a Mac OS X 10.7 laptop. It also runs on Apache
continuous integration servers running Linux. It is not typically run on Windows,
so if you issues with that, please log an issue.
continuous integration servers running Linux. The build is not typically run on Windows,
so if you have problems with that, please log an issue.

The weinre build pre-req's the following tools:

@@ -108,7 +108,7 @@ the archives.
### to run the output of the development build: ###

* run: `cd weinre.server`
* run: `./weinre [your flavorite options]`
* run: `node weinre [your flavorite options]`

### other fun development-time hacks ###

@@ -125,7 +125,7 @@ weinre server generated by the development build, whenever a weinre build
completes.

Putting this altogether, you can open two terminal windows, run `wr` in the `weinre.build`
directory to have a development build run whenever you change the source, and then run `weinre.hot` in the `weinre.server` directory to have the weinre server restart whenever a build completes, getting a growl notification at that time.
directory to have a development build run whenever you change the source, and then run `weinre-hot` in the `weinre.server` directory to have the weinre server restart whenever a build completes, getting a growl notification at that time.

updating 3rd party libraries
-----------------------------
@@ -137,7 +137,7 @@ If you're adding or updating a 3rd party library, make
sure the license is acceptable, and add/update the license in the top-level `LICENSE`
file.
All of the 3rd party dependencies used with weinre are stored in two directories:
All of the 3rd party dependencies used with weinre are stored in one of two directories:

* `weinre.build/vendor` - contains libraries used in the client and/or target,
as well as libraries used by the build itself
@@ -153,7 +153,7 @@ To update the files in `weinre.build/vendor`:

To update the files in `weinre.server/node_modules`:

* edit the file `weinre.build/package.json.template' as appropriate
* edit the file `weinre.build/package.json.template` as appropriate
* run a build (see above), so that the file `weinre.server/package.json` file is created
from the template you edited above
* run: `cd weinre.server`
@@ -17,31 +17,43 @@
* under the License.
-->

The files contained in this directory are the source for the
weinre server, implemented using the
[express package](http://expressjs.com/)
on the
[node.js](http://nodejs.org)
runtime.
weinre is WEb INspector REmote.
Pronounced like the word "winery".
Or maybe like the word "weiner".
Who knows, really.

The weinre server uses numerous 3rd party libraries, installed in the
`node_modules` directory, and stored in the SCM.
In case these need to be updated, the file
`package.json` should be updated with the dependencies and versions
needed, then run
weinre is a debugger for web pages,
like FireBug (for FireFox) and Web Inspector (for WebKit-based browsers),
except it's designed to work remotely, and in particular,
to allow you debug web pages on a mobile device such as a phone.

rm -rf node_modules; npm install
For more information on weinre:
[http://http://incubator.apache.org/callback/](http://incubator.apache.org/callback/)

to refresh the dependencies.
running
-------

For more information about running weinre, you can start the server
and browse the documentation online.

before running the weinre server
--------------------------------
Start the server with the following command

Before running the weinre server, after downloading the source,
you will need to run a 'build'.
node weinre

This will start the server, and display a message with the URL to the
server. Browse to that URL in your web browser, and then click on
'documentation' link, which will display weinre's online documentation.
From there click on the 'Running' page to get more information about
running weinre.

source
------

running the weinre server
-------------------------
Follow the link for more information at the top of this file
for instructions on obtaining source.

If you're reading this file as part of the source distribution of weinre,
you will need to run a 'build' before being able to run weinre. See the
`README.md` file in the root directory of the weinre source distribution
for more information.

This file was deleted.

Some generated files are not rendered by default. Learn more.

Some generated files are not rendered by default. Learn more.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

0 comments on commit 5b95d39

Please sign in to comment.