Read Me for KindFTP

Welcome to KindFTP, a Java implementation of the FTP (RFC959) protocol.

Source Code

This release of KindFTP does include source code. See the source directory for more information.

If you wish to contribute to KindFTP, please email kiniry@acm.org and we can discuss our process (e.g. patches, CVS access, contributor maintaining ownership of additions/changes, etc.).

Documentation

This release of KindFTP comes with several sets of documentation.

1. The KindFTP brief, a short summary of the package.
2. Full Javadoc-generated documentation is included in the docs/javadoc directory.
3. Miscellaneous other documentation (release notes, FAQ, TODO list, etc.) are included in several text files in the same directory as this file.
4. Use the source! The source code, or more specifically, the full Design by Contract specification that can be found in the source, is your best guide toward the correct use of KindFTP. We use the excellent KindSoftware Code Standard for KindFTP.

Using KindFTP

To learn how to use KindFTP, one should read the KindFTP Javadoc documentation. Additionally, the source code for the KindFTP blackbox test suite has been included, which should be very revealing to the interested developer.

Simply add one of the KindFTP jar files, depending on whether you want to use the instrumented version of the code or not, and the IDebug jar file to your CLASSPATH to use KindFTP. All library files are located in the libs directory.

Questions or comments?

Please email kiniry@acm.org.