4chan-x/README.md
Kabir Sala 1b6052304b Stuff
2014-02-09 21:43:31 +01:00

34 lines
909 B
Markdown
Executable File

Personal fork of Seaweed's 4chan X.
Don't expect new features, I don't know Javascript, Coffeescript or all this stuff.
Don't expect any bug fix.
Don't expect any support.
Actually, don't expect anything.
Works with Firefox only.
## 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.