summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFredrick Brennan:w <admin@8chan.co>2014-04-29 14:59:17 -0400
committerczaks <marcin@6irc.net>2014-04-30 00:36:05 +0200
commitc5576120d999148e7405a2c1509d1a22121a029b (patch)
tree62a90ea5e89b594a48bd1c37597701ddb2bbe7e1 /README.md
parent15a65caf9d4d98b9987eefb04b98180ce3c47aa9 (diff)
Oekaki instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index 000fb32f..e852bd3d 100644
--- a/README.md
+++ b/README.md
@@ -103,6 +103,18 @@ Wanting to have vichan in your language? You can contribute your translations at
https://www.transifex.com/projects/p/tinyboard-vichan-devel/
+Oekaki
+------
+
+vichan makes use of [wPaint](https://github.com/websanova/wPaint) for oekaki. After you pull the repository, however, you will need to download wPaint separately using git's `submodule` feature. Use the following commands:
+
+```
+git submodule init
+git submodule update
+```
+
+To enable oekaki, add all the scripts listed in `js/oekaki.js` to your `instance-config.php`.
+
License
--------
See [LICENSE.md](http://github.com/vichan-devel/vichan/blob/master/LICENSE.md).