diff --git a/README.html b/README.html index 14be41b..05a1eaa 100644 --- a/README.html +++ b/README.html @@ -7,14 +7,19 @@ -

Tidy for HTML5

-

This repo is a fork of the code from +

HTML Tidy for HTML5 (experimental)

+

This repo is an experimental fork of the code from tidy.sourceforge.net. This source code in this version supports processing of HTML5 documents. The changes for HTML5 support started from a patch developed by Björn Höhrmann.

-

For *nix platforms, you can build and install from the source code using the +

For more information, see + w3c.github.com/tidy-html5 + +

Building the tidy command-line tool

+

For Linux/BSD/OSX platforms, you can build and install the +tidy command-line tool from the source code using the following steps.

    @@ -24,3 +29,16 @@ following steps.

    Note that you will either need to run make install as root, or with sudo make install.

    + +

    Building the libtidy shared library

    +

    For Linux/BSD/OSX platforms, you can build and install the +tidylib shared library (for use in building other +applications) from the source code using the following steps.

    + +
      +
    1. sh build/gnuauto/setup.sh && ./configure && make
    2. +
    3. make install
    4. +
    + +

    Note that you will either need to run make install as root, +or with sudo make install.

    diff --git a/README.md b/README.md index a2d3174..0805fc7 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,38 @@ -# Tidy for HTML5 +# HTML Tidy for HTML5 (experimental) -This repo is a fork of the code from [tidy.sourceforge.net][1]. This source -code in this version supports processing of HTML5 documents. The changes for -HTML5 support started from a [patch developed by Björn Höhrmann][2]. +This repo is an experimental fork of the code from [tidy.sourceforge.net][1]. +This source code in this version supports processing of HTML5 documents. The +changes for HTML5 support started from a [patch developed by Björn Höhrmann][2]. [1]: http://tidy.sourceforge.net [2]: http://lists.w3.org/Archives/Public/www-archive/2011Nov/0007.html -For *nix platforms, you can build and install from the source code using the -following steps. +For more information, see [w3c.github.com/tidy-html5][3] + + [3]: http://w3c.github.com/tidy-html5/ + +## Building the tidy command-line tool + +For Linux/BSD/OSX platforms, you can build and install the `tidy` command-line +tool from the source code using the following steps. 1. `make -C build/gmake/` 2. `make install -C build/gmake/` -Note that you will either need to run `make install` as root, or with `sudo -make install`. +Note that you will either need to run `make install` as root, or with `sudo make +install`. +## Building the libtidy shared library + +For Linux/BSD/OSX platforms, you can build and install the `tidylib` shared +library (for use in building other applications) from the source code using the +following steps. + + 1. sh build/gnuauto/setup.sh && ./configure && make + + 2. make install + +Note that you will either need to run `make install` as root, or with `sudo make +install`.