e2m/dispatch
4
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update readme instructions

Browse Source
This commit is contained in:
Ken-Håvard Lieng 2015-05-29 02:55:28 +02:00
parent 284a35ab09
commit 4d8c52fa22
1 changed files with 34 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -1,39 +1,60 @@
# name_pending # name_pending
Web-based IRC client in Go. Web-based IRC client in Go.
## Installing ## Features
* Searchable history
* Persistent connections
* Multiple users
## Usage
There is a few different ways of getting it.
### 1. Binary
There will be binary releases.
### 2. Go
This requires a [Go environment](http://golang.org/doc/install).
```bash ```bash
go get github.com/khlieng/name_pending go get github.com/khlieng/name_pending
```
## Running
```bash
name_pending name_pending
``` ```
## Building the server To get some help run:
```bash
name_pending help
```
#### Requirements ### 3. Docker
* [Go](http://golang.org/doc/install) ```bash
docker run -p 8080:8080 khlieng/name_pending
```
## Build
### Server
```bash ```bash
cd $GOPATH/src/github.com/khlieng/name_pending cd $GOPATH/src/github.com/khlieng/name_pending
go install go install
``` ```
## Building the client ### Client
This requires [Node.js](https://nodejs.org/download/).
#### Requirements
* [Node.js + npm](https://nodejs.org/download/)
Fetch the dependencies:
```bash ```bash
npm install -g gulp npm install -g gulp
go get github.com/jteeuwen/go-bindata/... go get github.com/jteeuwen/go-bindata/...
cd $GOPATH/src/github.com/khlieng/name_pending/client cd $GOPATH/src/github.com/khlieng/name_pending/client
npm install npm install
```
Run the build:
```bash
gulp -p gulp -p
```
# Rebuild the server :) The server needs to be rebuilt after this. For development dropping the -p flag
``` will turn off minification and embedding, requiring only one initial server rebuild.