Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 1.49 KB

README.md

File metadata and controls

47 lines (30 loc) · 1.49 KB
Raw

guarid-go

Build Status docs examples

Quick Start

To install:

go get bitbucket.org/enmand/quarid-go

To run

If your $PATH includes $GOPATH/bin: run quarid-go --config config.json Othwise, run: $GOPATH/bin/quarid-go --config config.json

Getting Started

Requirements

This bot has been tested with Go 1.4.1, although Go 1.3 should work as well.

Your $GOPATH

Make sure your $GOPATH is configured for your shell. You should also update your $PATH to include $GOPATH/bin, so you can run quarid-go.

Installing Quarid locally

If you don't want to install Quarid in the above way for a binary quarid-go binary in $GOPATH/bin, you can see the Hacking section to find out more.

Check out repository

mkdir -p $GOPATH/src/bitbucket.org/enmand/
cd $GOPATH/src/bitbucket.org/enmand
git clone [email protected]:enmand/quarid.go

Plugins

Plugins should have a file named *<PluginName>_plugin.go. The plugin should call the RegisterPlugin method.

See random_plugin.go for an example.

Local build

To build a local build of quarid-go run make bin/quarid-go