4chan-x/README.md
2014-04-03 15:59:40 -07:00

37 lines
1.1 KiB
Markdown
Executable File

Personal fork of Spittie's 4chan X.
#### [Why 4chan X needs to access data on every site?](https://github.com/ccd0/4chan-x/wiki/Why-4chan-X-needs-to-access-data-from-every-website%3F)
##[Install](https://ccd0.github.io/4chan-x/builds/4chan-X.user.js) (Firefox)
##[Install](https://ccd0.github.io/4chan-x/builds/crx.crx) (Chrom*)
<!---
##[Install](http://a.pomf.se/tkhuwm.xpi) (Firefox Mobile)
-->
## If you have any problems, try resetting your 4chan X settings
## Forking
### Get started
- Get started by reading through the [Help link](https://help.github.com/) on how to fork a Github project.
- Click the "Fork" button on this page.
- Install [node.js](http://nodejs.org/).
- Install [Grunt's CLI](http://gruntjs.com/) with `npm install -g grunt-cli`.
- Clone your fork of 4chan X.
- `cd` into it.
- Install/Update 4chan X dependencies with `npm install`.
### Build
- Build with `grunt`.
- Continuously build with `grunt watch`.
### Release
- Update the version with `grunt patch`, `grunt minor` or `grunt major`.
- Release with `grunt release`.
Note: this is only used to release new 4chan X versions, ignore as you see fit.