summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorAlex Xu <alex_y_xu@yahoo.ca>2014-03-30 13:43:33 -0400
committerAlex Xu <alex_y_xu@yahoo.ca>2014-03-30 14:03:21 -0400
commit84a59ae28b1c5cf4b7d0afae49fa3e64b39b98a2 (patch)
treee5aefea27428a51738f5bd02d69a15bd314e70d3 /README.rst
parentffebbcd2dee04b8c06e90432618e0e013ac5b7dc (diff)
downloadhtml5ks-84a59ae28b1c5cf4b7d0afae49fa3e64b39b98a2.tar.xz
html5ks-84a59ae28b1c5cf4b7d0afae49fa3e64b39b98a2.zip
add configure
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst16
1 files changed, 8 insertions, 8 deletions
diff --git a/README.rst b/README.rst
index facaf3f..950e6b9 100644
--- a/README.rst
+++ b/README.rst
@@ -24,7 +24,7 @@ Requirements
- cwebp and webpmux from libwebp
- convert from ImageMagick
- apngasm
-- Node.js, npm
+- Node.js, npm for uglifyjs
Recommended
'''''''''''
@@ -36,15 +36,15 @@ Recommended
- jpegtran
- nginx
- pngquant
-- zopfli
+- zopfli and zopflipng
Build steps
-----------
0. Get Katawa Shoujo, install prerequisites. For guidance on Ubuntu, see .travis.sh.
-1. Copy \*.rpyc from Katawa Shoujo/game into unrpyc/ directory.
-2. Extract files from Katawa Shoujo/game/data.rpa with an rpa extractor, e.g. unrpa. Put files in www/dump.
-3. Install prerequisites, download DeflOpt and defluff and place exes in this directory.
+1. Copy \*.rpyc from Katawa Shoujo/game into ast2json/ directory.
+2. Extract files from Katawa Shoujo/game/data.rpa to www/dump/ with an rpa extractor, like rpatool or unrpa.
+3. Install prerequisites.
4. Run ./configure.
5. Run make.
6. Run nginx.sh to start nginx, then navigate to localhost:8080 in your browser.
@@ -55,10 +55,10 @@ Disabling unused conversions
----------------------------
To reduce programs and build time required, some conversions can be disabled.
-Defining MINIMAL as an environment variable will disable the safe ones.
+Passing --minimal to configure will disable the safe ones.
-Alternatively, specific conversions can be disabled by passing ``PROGRAM=`` on the command line, i.e. leaving it undefined.
-See the Makefile for more information.
+Alternatively, specific conversions can be disabled by passing --disable-conversion on the command line.
+See ``./configure --help`` for more information.
Reducing disk usage
-------------------