Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Trejo <david.daniel.trejo@gmail.com>2011-01-24 07:52:37 +0300
committerRyan Dahl <ry@tinyclouds.org>2011-01-28 03:20:31 +0300
commit3a05a6eaca578cdaea19e8e23a1411de324e7d07 (patch)
tree8c330333a8cf3d687e40b68febe6552600836852 /README.md
parent1a5e5130843b5eca79fce60a6c032f3d7ac61017 (diff)
newcomer resources in README
Closes GH-579.
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000000..3dbbb0d9355
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+Evented I/O for V8 javascript.
+===
+
+To build:
+
+ ./configure
+ make
+ make install
+
+To run the tests:
+
+ make test
+
+To build the documentation:
+
+ make doc
+
+To read the documentation:
+
+ man doc/node.1
+
+Resources for Newcomers
+---
+ - [nodejs.org](http://nodejs.org/)
+ - [how to install node.js and npm (node package manager)](joyeur.com/2010/12/10/installing-node-and-npm/)
+ - [list of modules](github.com/ry/node/wiki/modules)
+ - [list of companies and projects using node](github.com/ry/node/wiki)
+ - [node.js mailing list](http://groups.google.com/group/nodejs)
+ - irc chatroom, [#node.js on freenode.net](http://webchat.freenode.net?channels=node.js&uio=d4)
+ - [community](https://github.com/ry/node/wiki/Community)
+ - [contributing](https://github.com/ry/node/wiki/Contributing)
+ - [big list of all the helpful wiki pages](https://github.com/ry/node/wiki/_pages)