From a9b5f02626bbbc569191292b5781538b739fb0ed Mon Sep 17 00:00:00 2001 From: Jordan Bates Date: Wed, 24 Apr 2013 13:00:52 -0700 Subject: [PATCH] Update readme --- README.md | 40 +++++++++++++++++++++++++++++++++++----- 1 file changed, 35 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c8c176c3d..44f822588 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,38 @@ -# 4chan X +# Get 4chan X [HERE](http://seaweedchan.github.io/4chan-x/). -Get it [here](https://4chan-x.just-believe.in/). +## Reporting bugs -*** +1. Make sure your **browser** & **4chan X** are up to date. +2. Please include as much information as possible, including your internet browser +3. Disable your other extensions & scripts. +4. If your issue persists: + 1. Report precise steps to reproduce the problem. + 2. Report console errors, if any. + 3. Report browser and browser version. -### [MIT License](/LICENSE) -### [Contribute](/CONTRIBUTING.md) +Open your console with: +- `Ctrl + Shift + J` on Chrome & Firefox +- `Ctrl + Shift + O` on Opera. + +## Development & Contribution + +### Get started + +- Clone 4chan X. +- `cd` into it. +- Install [node.js](http://nodejs.org/). +- Install [Grunt's CLI](http://gruntjs.com/) with `npm install -g grunt-cli`. +- Install 4chan X dependencies with `npm install`. + +### Build + +- Build with `grunt`. +- For development (continuous builds), run `grunt watch`. + +### Contributing + +- Fork the repo +- Edit the CoffeeScript source +- Build the JavaScript +- If the edits affect regular users, edit the changelog +- Send a pull request