Skip to content
Permalink
Browse files
improve docs
git-svn-id: https://svn.apache.org/repos/asf/ant/antlibs/dotnet/trunk@439160 13f79535-47bb-0310-9956-ffa450edef68
  • Loading branch information
bodewig committed Sep 1, 2006
1 parent 3c361ab commit 4eb56eea72272e82d1dbc8d021501f0dcd96417e
Showing 8 changed files with 85 additions and 39 deletions.

This file was deleted.

47 README
@@ -1,31 +1,36 @@
dotnet README
=============
What's this?
============

Goal:
-----
This library doesn't strive to replace NAnt or MSBuild, its main
purpose is to help those of us who work on projects crossing platform
boundaries. With this library you can use Ant to build and test the
Java as well as the .NET parts of your project.

Provide a simple infrastructure to execute .NET applications from
within Ant for different VMs so that the user doesn't have to change
the build file when she wants to run Mono on Linux and Microsoft's VM
on Windows.
Learn more
==========

This sounds far more ambitioned than it actually is.
The documentation is included in the docs subdirectory of this
distribution. The home of this library is
<http://ant.apache.org/antlibs/dotnet/index.html>.

Short term goals are:
Building
========

* A <dotnetexec> task that can be used as
This Ant Library requires Ant 1.7.0 to build, some of the test use
JUnit 3 (3.8.2 recommended), others use the sister Antlib AntUnit (see
<http://ant.apache.org/antlibs/antunit/index.html>).

<dotnetexec executable="ExampleCsc.exe"/>
It should work with any Java(TM) Runtime (and compile with any Java(TM)
Developer Kit) starting with version 1.2.

without testing for the environment (see the dotnet.xml build file
for Ant's tests as an example for what may become simpler with
this).
It should support the Microsoft .NET framework in versions 1.1 and 2.0
and Mono in various versions on various platforms.

* A <nant> task.
Using
=====

* A <msbuild> task - if only for the fun of having it.

* A <wix> task.

* A <nunit> task.
You use this Ant library like any other Ant library 8-)

In short you can make it available to Ant in a variety of ways, please
see the Ant manual or the index.html file in the docs subdirectory of
this distribtion for details.
13 TODO
@@ -0,0 +1,13 @@
Things to do before the beta can become a final release:

* make dotnetexec tests independent of the "old" tasks, i.e. make the tests self-contained

* apparently the wsdl2dotnet tests fail on Mono/Linux

* ildasm test fails on Microsoft .NET 2.0

* test in a wider variety of platforms

* AntUnitize more tests

* make docs a little bit more accessible
@@ -0,0 +1,25 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE contributors
[
<!ELEMENT name (first?, middle?, last)>
<!ELEMENT contributors (introduction, name+)>
<!ELEMENT first (#PCDATA)>
<!ELEMENT introduction (#PCDATA)>
<!ELEMENT middle (#PCDATA)>
<!ELEMENT last (#PCDATA)>
]
>

<contributors>
<introduction>
These are some of the many people who have helped with this Ant Library.
</introduction>
<name>
<first>Brian</first>
<last>Watson</last>
</name>
<name>
<first>Stefan</first>
<last>Bodewig</last>
</name>
</contributors>
@@ -37,31 +37,36 @@ <h2>Introduction</h2>

<h2>Requirements</h2>

<p>The current version requires Ant 1.7 or at least a version
built from svn trunk no earlier than 2005-12-16.</p>
<p>The current version requires Ant 1.7.0 (beta).</p>

<h2>Where is it?</h2>

<p>The source code for the library lives in Ant's SVN - <a
href="http://svn.apache.org/repos/asf/ant/antlibs/dotnet/trunk/">http://svn.apache.org/repos/asf/ant/antlibs/dotnet/trunk/</a>
A binary can be found at <a
href="http://people.apache.org/~bodewig/dotnet/ant-dotnet.jar">http://cvs.apache.org/~bodewig/dotnet/ant-dotnet.jar</a>.
A zip file containing the docs is also <a
href="http://people.apache.org/~bodewig/dotnet/docs.zip">available</a>.</p>

<p>Note that these are temporary locations and may change later.</p>
href="http://svn.apache.org/repos/asf/ant/antlibs/dotnet/trunk/">http://svn.apache.org/repos/asf/ant/antlibs/dotnet/trunk/</a>,
binary and source distributions are available available from the
Ant website: <a
href="http://ant.apache.org/antlibs/srcdownload.cgi">source</a>
and <a
href="http://ant.apache.org/antlibs/bindownload.cgi">binary</a>.</p>

<h2>Feedback</h2>

<p>Please direct any feedback to the <a
href="http://ant.apache.org/mail.html#Developer List">Ant
developer list</a>.
<p>Please use <a href="http://issues.apache.org/bugzilla/">Ant's
issue tracker</a> for bug reports, choose "Ant" as the product and
".NET Antlib" as the category. The <a
href="http://ant.apache.org/bugs.html">hints</a> about reporting
bugs certainly apply to this Ant library as well.</p>

<p>For questions about this Ant library use the user or dev <a
href="http://ant.apache.org/mail.html">mailing list</a> of the Ant
project. You must be subscribed to the list in order to post a
question.</p>

<h2>Installation</h2>

<p>If you are building this from sources, run the antlib target
and you'll get a file <code>ant-dotnet.jar</code>. If you've
downloaded <code>dotnet.jar</code>, you are already ready.</p>
downloaded a binary release, you are already there.</p>

<p>There are several ways to use the tasks:</p>

@@ -24,7 +24,7 @@
</head>

<body>
<h2><a name="dotnetexec">MSBuild</a></h2>
<h2><a name="msbuild">MSBuild</a></h2>

<h3>Description</h3>

@@ -24,7 +24,7 @@
</head>

<body>
<h2><a name="dotnetexec">NAnt</a></h2>
<h2><a name="nant">NAnt</a></h2>

<h3>Description</h3>

@@ -24,7 +24,7 @@
</head>

<body>
<h2><a name="dotnetexec">NUnit</a></h2>
<h2><a name="nunit">NUnit</a></h2>

<h3>Description</h3>

0 comments on commit 4eb56ee

Please sign in to comment.