More documentation updates, but to be corrected later
This commit is contained in:
parent
06871fa96b
commit
19d9585598
24
README.html
24
README.html
|
@ -7,14 +7,19 @@
|
|||
</style>
|
||||
</head>
|
||||
|
||||
<h1>Tidy for HTML5</h1>
|
||||
<p>This repo is a fork of the code from
|
||||
<h1>HTML Tidy for HTML5 (experimental)</h1>
|
||||
<p>This repo is an experimental fork of the code from
|
||||
<a href="http://tidy.sourceforge.net">tidy.sourceforge.net</a>.
|
||||
This source code in this version supports processing of HTML5 documents.
|
||||
The changes for HTML5 support started from a
|
||||
<a href="http://lists.w3.org/Archives/Public/www-archive/2011Nov/0007.html">patch developed by Björn Höhrmann</a>.</p>
|
||||
|
||||
<p>For *nix platforms, you can build and install from the source code using the
|
||||
<p>For more information, see
|
||||
<a href="http://w3c.github.com/tidy-html5/">w3c.github.com/tidy-html5</a>
|
||||
|
||||
<h2>Building the tidy command-line tool</h2>
|
||||
<p>For Linux/BSD/OSX platforms, you can build and install the
|
||||
<code>tidy</code> command-line tool from the source code using the
|
||||
following steps.</p>
|
||||
|
||||
<ol>
|
||||
|
@ -24,3 +29,16 @@ following steps.</p>
|
|||
|
||||
<p>Note that you will either need to run <code>make install</code> as root,
|
||||
or with <code>sudo make install</code>.</p>
|
||||
|
||||
<h2>Building the libtidy shared library</h2>
|
||||
<p>For Linux/BSD/OSX platforms, you can build and install the
|
||||
<code>tidylib</code> shared library (for use in building other
|
||||
applications) from the source code using the following steps.</p>
|
||||
|
||||
<ol>
|
||||
<li>sh build/gnuauto/setup.sh && ./configure && make</li>
|
||||
<li>make install</li>
|
||||
</ol>
|
||||
|
||||
<p>Note that you will either need to run <code>make install</code> as root,
|
||||
or with <code>sudo make install</code>.</p>
|
||||
|
|
34
README.md
34
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`.
|
||||
|
|
Loading…
Reference in a new issue