Permalink
Browse files

Update the README with external depencencies.

  • Loading branch information...
1 parent 9d23e05 commit 30867aad9b3ff5d74c195d5670aadfe3cbb66c99 @TooTallNate TooTallNate committed Feb 4, 2012
Showing with 18 additions and 3 deletions.
  1. +18 −3 README.md
View
@@ -17,15 +17,28 @@ downloads the necessary development files for the target version).
* Supports multiple target versions of Node
-How to Use
-----------
+Installation
+------------
-The first step is to install. With `npm`, invoke:
+To install with `npm`, invoke:
``` bash
$ npm install -g node-gyp
```
+You will also need:
+
+ * Unix
+ * `python`
+ * `make`
+ * A proper C/C++ compiler toolchain, like GCC
+ * Windows
+ * [Python][windows-python]
+ * Microsoft Visual C++ ([Express][msvc] version works well)
+
+How to Use
+----------
+
To compile your native addon, first go to its root directory:
``` bash
@@ -104,4 +117,6 @@ TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+[windows-python]: http://www.python.org/getit/windows
+[msvc]: http://www.microsoft.com/visualstudio/en-us/products/2010-editions/visual-cpp-express
[node-bindings]: https://github.com/TooTallNate/node-bindings

0 comments on commit 30867aa

Please sign in to comment.