search

lukevers / kittens

A scriptable IRC bot hub written in Go with Lua plugins
MIT License
83 stars 10 forks source link

Add getting started info to README #36

Closed zackkitzmiller closed 10 years ago

zackkitzmiller commented 10 years ago

It's not currently clear how to get started running this package. Information in the README would be ideal.

lukevers commented 10 years ago

Good point. I thought about earlier today adding a section in the README for that, but had to run out of the house for a little bit. I'll go ahead later today and write something up, but for now here's some basic instructions:

  1. Clone the repository
  2. Run go get
  3. Run go build

To build the CSS/JS I use Gulp to compile LESS into CSS and concat all the CSS into one file (same with JS). If you've never used gulp before, check it out, it's pretty cool. It's not a requirement, as this could be manually done, but it's my preferred way. To go ahead and install Gulp you need NPM installed. 

# Install gulp globally
npm install -g gulp
# Install gulp packages needed in dir
npm install
# Run gulp
gulp less && gulp

Right now everything is loaded from ./config.json so the example file needs to be copied to have that name in the same directory. The contents should be edited to what's needed for you to connect to certain servers and channels.

After all that is done you can just run it via ./kittens for right now.

Thanks for adding this as an issue, as I really should have done all of this earlier today when I thought about it!

On Jul 6, 2014, at 12:56 PM, Zack Kitzmiller notifications@github.com wrote:

It's not currently clear how to get started running this package. Information in the README would be ideal.

— Reply to this email directly or view it on GitHub.

zackkitzmiller commented 10 years ago

This looks great, and works fine assume a correct $GOPATH. It seems that I had somehow mucked up my GOPATH earlier today, which was causing my issues.

Regardless, this should be added to the README. Thanks.

lukevers commented 10 years ago

Ahhh yes a correct GOPATH is needed. I'll make sure to say something about that too.

On Jul 6, 2014, at 1:16 PM, Zack Kitzmiller notifications@github.com wrote:

This looks great, and works fine assume a correct $GOPATH. It seems that I had somehow mucked up my GOPATH earlier today, which was causing my issues.

Regardless, this should be added to the README. Thanks.

— Reply to this email directly or view it on GitHub.