Browse Source

update README and CHANGELOG

Ashish Kulkarni 11 years ago
parent
commit
0ceef73ad8
2 changed files with 12 additions and 8 deletions
  1. 1 1
      CHANGELOG.md
  2. 11 7
      INSTALL.md

+ 1 - 1
CHANGELOG.md

@@ -22,7 +22,7 @@ v0.12.1 (unreleased)
 * update URLs in the internal documentation
 * generate API documentation for libwkhtmltox (on the website)
 * display version in compiled binary properly under various scenarios
-* complete revamp of the build system
+* complete revamp of the build system, which now generates native packages on all platforms
 
 v0.12.0 (2014-02-06)
 --------------------

+ 11 - 7
INSTALL.md

@@ -13,11 +13,11 @@ Please ensure that you have enough disk space in the location you have cloned
 the source code, as it will require approximately 1.2GiB for both the `qt` and
 `wkhtmltopdf` repositories. Each target that is built will require an
 additional 2.5GiB for compiling the source code and producing the final
-installer (for Windows) or tarballs (for other OSes), which will be generated
+installer (for Windows) or packages (for other OSes), which will be generated
 in the `static-build/` folder.
 
-You can create a debug build by passing the ` -debug` flag to the build script.
-It is recommended to always pass the ` -clean` flag, which removes the
+You can create a debug build by passing the `-debug` flag to the build script.
+It is recommended to always pass the `-clean` flag, which removes the
 existing build folder and performs a clean build. Note that passing `-debug`
 may increase the disk space required for the build and final binaries for
 storing the additional debug information.
@@ -68,8 +68,8 @@ user and running it as `root` may lead to errors or complete loss of data.
 
 After the build environment is setup, you can run the command mentioned above
 to build either the 32-bit or 64-bit binaries, which should generate a
-compressed tarball using [xz](http://tukaani.org/xz/) in the `static-build/`
-folder.
+native package (either DEB or RPM, depending on the distribution) in the
+`static-build/` folder.
 
 Windows
 -------
@@ -120,8 +120,12 @@ file sizes and selectable text as compared to the Cocoa version, see
 
 Target          | Build Command
 ------          | -------------
-32-bit Carbon   | `scripts\build.py osx-carbon-i386`
-64-bit Cocoa    | `scripts\build.py osx-cocoa-x86-64`
+32-bit Carbon   | `scripts/build.py osx-carbon-i386`
+64-bit Cocoa    | `scripts/build.py osx-cocoa-x86-64`
+
+During the build, a working internet connection is required to download and
+compile the dependent libraries (e.g. libpng and libjpeg). The output package
+should be generated in the `static-build` folder.
 
 Others
 ------