1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/maindocs.h	Sat May 24 17:25:06 2008 -0700
     1.3 @@ -0,0 +1,53 @@
     1.4 +//
     1.5 +//  maindocs.h
     1.6 +//  MYNetwork
     1.7 +//
     1.8 +//  Created by Jens Alfke on 5/24/08.
     1.9 +//  Copyright 2008 Jens Alfke. All rights reserved.
    1.10 +//
    1.11 +// This file just contains the Doxygen comments that generate the main (index.html) page content.
    1.12 +
    1.13 +
    1.14 +/*! \mainpage MYNetwork: Mooseyard Networking library, including BLIP protocol implementation. 
    1.15 + 
    1.16 +    \section intro_sec Introduction
    1.17 + 
    1.18 +    MYNetwork is a set of Objective-C networking classes for Cocoa applications on Mac OS X.
    1.19 +    It consists of:
    1.20 +    <ul>
    1.21 +    <li>Networking utility classes (presently only IPAddress);
    1.22 +    <li>A generic TCP client/server implementation,
    1.23 +        useful for implementing your own network protocols; (see TCPListener and TCPConnection)
    1.24 +    <li>An implementation of BLIP, a lightweight network protocol I've invented as an easy way
    1.25 +        to send request and response messages between peers. (see BLIPListener, BLIPConnection, BLIPRequest, etc.)
    1.26 +    </ul>
    1.27 + 
    1.28 +    MYNetwork is released under a BSD license, which means you can freely use it in open-source
    1.29 +    or commercial projects, provided you give credit in your documentation or About box.
    1.30 + 
    1.31 +    \section config Configuration
    1.32 + 
    1.33 +    MYNetwork requires Mac OS X 10.5 or later, since it uses Objective-C 2 features like
    1.34 +    properties and for...in loops.
    1.35 + 
    1.36 +    MYNetwork uses my <a href="/hg/hgwebdir.cgi/MYUtilities">MYUtilities</a> library. You'll need to have downloaded that library, and added
    1.37 +    the necessary source files and headers to your project. See the MYNetwork Xcode project,
    1.38 +    which contains the minimal set of MYUtilities files needed to build MYUtilities. (That project
    1.39 +    has its search paths set up to assume that MYUtilities is in a directory next to MYNetwork.)
    1.40 +
    1.41 +    \section download How To Get It
    1.42 +
    1.43 +    <ul>
    1.44 +    <li><a href="http://mooseyard.com/hg/hgwebdir.cgi/MYNetwork/archive/tip.zip">Download the current source code</a>
    1.45 +    <li>To check out the source code using <a href="http://selenic.com/mercurial">Mercurial</a>:
    1.46 +    \verbatim hg clone http://mooseyard.com/hg/hgwebdir.cgi/MYNetwork/ MYNetwork \endverbatim
    1.47 +    </ul>
    1.48 +
    1.49 +    Or if you're just looking:
    1.50 +
    1.51 +    <ul>
    1.52 +    <li><a href="http://mooseyard.com/hg/hgwebdir.cgi/MYNetwork/file/tip">Browse the source code</a>
    1.53 +    <li><a href="annotated.html">Browse the class documentation</a>
    1.54 +    </ul>
    1.55 + 
    1.56 + */