resolution for * JAL-553
[jalview.git] / utils / jalopy / readme.html
1 <html><head>
2 <!--
3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
4  * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
5  * 
6  * This file is part of Jalview.
7  * 
8  * Jalview is free software: you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License 
10  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
11  * 
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
18 -->
19       <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
20    <title></title><link rel="stylesheet" href="./docs/site.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.65.1"></head><body id="toppage" bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table width="700" border="0" cellpadding="0" cellspacing="0" align="center"><tr><td><table cellpadding="0" cellspacing="0" width="100%" style="border:1px solid #336699"><tbody><tr><td height="16"></td></tr><tr><td bgcolor="#3399cc" height="1"></td></tr><tr style="border:none"><td style="border:none"><table border="0" cellspacing="0" cellpadding="0"><tbody><tr><td class="logo">JALOPY</td><td class="sublogo" valign="bottom">Java Source Code Formatter Beautifier Pretty Printer</td></tr></tbody></table></td></tr><tr><td bgcolor="#3399cc" height="1"></td></tr><tr><td height="10"></td></tr><tr><td bgcolor="#ff8000" height="4"></td></tr><tr><td height="20" bgcolor="#336699" style="color:#ffffff;padding-left:10px"><a href="./docs/index.html" class="navlink">Overview</a> &#149;
21                     <a href="./docs/download.html" class="navlink">Download</a> &#149;
22                     <a href="./docs/docs.html" class="navlink">Documentation</a> &#149;
23                     <a href="./docs/plugins.html" class="navlink">Plug-ins</a> &#149;
24                     <a href="./docs/links.html" class="navlink">Links</a> &#149;
25                     <a href="./docs/contact.html" class="navlink">Contact</a></td></tr><tr><td height="1" bgcolor="#ffffff"></td></tr></tbody></table></td></tr><tr><td height="20" bgcolor="#ffffff"></td></tr><tr><td bgcolor="#eeeecc" height="17" style="padding-right:3px"></td></tr><tr valign="top"><td valign="top" bgcolor="#ffffff"><table border="0" width="100%" cellspacing="0" cellpadding="5"><tbody><tr><td><div class="article" lang="en"><div class="simplesect" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d4e2"></a>README Ant Task</h2></div></div><div></div></div></div><p>
26 This is the README for the Ant Task distribution of the Jalopy Java
27 Source Code Formatter. This Plug-in provides the integration with the
28 wonderful Jakarta build tool.
29 </p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d4e5"></a>1.&nbsp;Distribution libraries</h2></div></div><div></div></div><p>
30 This distribution contains the following libraries:
31 </p><div class="itemizedlist"><ul type="square"><li style="list-style-type: square">
32   AElfred XML Parser (<tt class="filename">aelfred-1.2.jar</tt>)
33 </li><li style="list-style-type: square">
34   A modified and re-packaged <a href="http://www.antlr.org" target="_top">ANTLR</a> Parser Generator runtime 2.7.2a2 (bundled with the Jalopy runtime)
35 </li><li style="list-style-type: square">
36   Jalopy Java Source Code Formatter runtime (<tt class="filename">jalopy-1.0b11.jar</tt>)
37 </li><li style="list-style-type: square">
38   Jalopy Ant Task (<tt class="filename">jalopy-ant-0.6.2.jar</tt>)
39 </li><li style="list-style-type: square"><a href="http://java.sun.com/xml/" target="_top">JAXP</a> Java API for XML Processing (<tt class="filename">jaxp-1.2.jar</tt>)
40 </li><li style="list-style-type: square"><a href="http://www.jdom.org/" target="_top">JDOM</a> XML API (<tt class="filename">jdom-1.0b8.jar</tt>)
41 </li><li style="list-style-type: square"><a href="http://jakarta.apache.org/log4j/" target="_top">log4j</a> logging toolkit (<tt class="filename">log4j-1.2.6.jar</tt>)
42 </li><li style="list-style-type: square"><a href="http://jakarta.apache.org/oro/" target="_top">Oro</a> Regular expressions (<tt class="filename">oro-2.0.6.jar</tt>)
43 </li><li style="list-style-type: square"><a href="http://www.saxproject.org/" target="_top">SAX</a> Simple API for XML (<tt class="filename">sax-2.0.1.jar</tt>)
44 </li></ul></div><p></p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d4e33"></a>2.&nbsp;Latest version</h2></div></div><div></div></div><p>
45 Details of the latest version can be found on the Jalopy project
46 web site at SourceForge, see
47 <a href="http://jalopy.sf.net/" target="_top">http://jalopy.sf.net</a>.
48 </p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d4e37"></a>3.&nbsp;Installation</h2></div></div><div></div></div><p>
49 For installation instructions, see
50 <a href="./docs/plugin-ant.html#plugin-ant-installation" target="_top">/docs/plugin-ant.html</a>.
51 </p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d4e41"></a>4.&nbsp;Custom build</h2></div></div><div></div></div><p>
52 For build instructions, see
53 <a href="./docs/build.html" target="_top">/docs/build.html</a>.
54 </p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d4e45"></a>5.&nbsp;Change history</h2></div></div><div></div></div><p>
55 To learn about implementation changes, fixed bugs and new features of this
56 version, see <a href="./docs/history.html" target="_top">/docs/history.html</a>.
57 </p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d4e49"></a>6.&nbsp;Licensing</h2></div></div><div></div></div><p>
58 This Plug-in is licensed under a
59 <a href="./docs/license-bsd.html" target="_top">BSD License</a>. For
60 additional license terms of the used 3rd-party libraries, please refer to
61 <a href="./docs/dependencies.html" target="_top">Appendix A</a>.
62 </p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d4e54"></a>7.&nbsp;Contact</h2></div></div><div></div></div><p>
63 For ways to contact the author or submit bug, feature or support requests, see
64 <a href="./docs/contact.html" target="_top">/docs/contact.html</a>.
65 </p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d4e58"></a>8.&nbsp;Contributors</h2></div></div><div></div></div><p>
66 For a list of project contributors, see
67 <a href="./docs/contributors.html" target="_top">/docs/contributors.html</a>.
68 </p></div></div></td></tr><tr><td height="20"></td></tr></tbody></table></td></tr><tr><td bgcolor="#eeeecc" height="17" style="font-size:9px;padding-left:5px"><a href="#toppage">to top</a></td></tr><tr><td height="30"><br></td></tr><tr><td height="3"></td></tr><tr><td bgcolor="#336699" height="1"></td></tr><tr><td height="1"></td></tr><tr><td bgcolor="#336699" height="16"></td></tr><tr><td bgcolor="#ff9966" height="4"></td></tr><tr><td class="footer" align="center" height="15" valign="middle">
69             Copyright &copy; 2001-2002, <a class="footer" href="./docs/contact.html">Marco Hunsicker</a>. All rights reserved.
70           </td></tr></table></body></html>