diff --git a/README b/README deleted file mode 100644 index 18e076074c..0000000000 --- a/README +++ /dev/null @@ -1,24 +0,0 @@ -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 - -See http://nodejs.org/ for more information. For help and discussion -subscribe to the mailing list by visiting -http://groups.google.com/group/nodejs or by sending an email to -nodejs+subscribe@googlegroups.com. diff --git a/README.md b/README.md new file mode 100644 index 0000000000..3dbbb0d935 --- /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)