diff --git a/README.md b/README.md new file mode 100644 index 00000000..05e75b17 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# name_pending +Web-based IRC client in Go. + +## Building + +#### Requirements +* [Go](http://golang.org/doc/code.html) +* [Node.js + npm](http://nodejs.org/download/) + +#### Get the source +```bash +go get github.com/khlieng/name_pending +``` + +#### Compile the server +```bash +cd $GOPATH/src/github.com/khlieng/name_pending +go build -o bin/name_pending +``` + +#### Build the client +```bash +npm install -g gulp + +cd client +npm install +gulp -p +```