Update readme

This commit is contained in:
Jordan Bates 2013-04-24 13:00:52 -07:00
parent eb0386c82f
commit a9b5f02626

View File

@ -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