Skip to content

Commit

Permalink
update readme with installation requirements
Browse files Browse the repository at this point in the history
Remove requirement to have libxml2-dev or whatever installed. The
libxml2 sources ship with this module.
  • Loading branch information
defunctzombie committed May 3, 2013
1 parent 8726d85 commit 373b899
Showing 1 changed file with 4 additions and 26 deletions.
30 changes: 4 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ var child = children[0];
console.log(child.attr('foo').value()); // prints "bar"
```

## Basics
## Support

* Docs - [http://github.com/polotek/libxmljs/wiki](http://github.com/polotek/libxmljs/wiki)
* Mailing list - [http://groups.google.com/group/libxmljs](http://groups.google.com/group/libxmljs)
Expand All @@ -37,35 +37,13 @@ Check out the wiki [http://github.com/polotek/libxmljs/wiki](http://github.com/p

See the [examples](https://github.com/polotek/libxmljs/tree/master/examples) folder.

## Requirements

* [libxml2](http://www.xmlsoft.org/)

You will need have the libxml2 library installed and also the libxml2-devel (libxml2-dev on debian systems)
package. This comes with the `xml2-config` utility that is needed for
compiling. **This command must be in your path.**

## Installation

**npm**
## Installation via [npm](https://npmjs.org)

```shell
npm install libxmljs
```

**source**
### Requirements

To build with node-gyp:
Make sure you have met the requirements for [node-gyp](https://github.com/TooTallNate/node-gyp#installation). You DO NOT need to manually install node-gyp; it comes bundled with node.

```shell
node-gyp configure
node-gyp build
```

Alternatively, run `make`.

**tests**

```shell
npm test
```

0 comments on commit 373b899

Please sign in to comment.