snej@2: //
snej@2: //  maindocs.h
snej@2: //  MYCrypto
snej@2: //
snej@2: //  Created by Jens Alfke on 4/06/09.
snej@2: //  Copyright 2009 Jens Alfke. All rights reserved.
snej@2: //
snej@2: // This file just contains the Doxygen comments that generate the main (index.html) page content.
snej@2: 
snej@2: 
snej@2: /*! \mainpage MYCrypto: Mooseyard Cryptography Library
snej@2:  
snej@2:     <center><b>By <a href="/Jens/">Jens Alfke</a></b></center>
snej@2: 
snej@2: \section intro_sec Introduction
snej@2:  
snej@2:     MYCrypto is a set of Objective-C cryptography classes for Cocoa applications on Mac OS X and iPhone.
snej@2:     
snej@2:     <a href="annotated.html">Browse the class documentation.</a>
snej@2:  
snej@2: \section license License
snej@2:  
snej@2:  MYCrypto is released under a BSD license, which means you can freely use it in open-source
snej@2:  or commercial projects, provided you give credit in your documentation or About box.
snej@2:    
snej@2: \section config Configuration
snej@2:  
snej@2:     MYCrypto requires Mac OS X 10.5 or later, since it uses Objective-C 2 features like
snej@2:     properties and for...in loops.
snej@2:  
snej@2:     MYCrypto uses my <a href="/hg/hgwebdir.cgi/MYUtilities">MYUtilities</a> library. You'll need to have downloaded that library, and added
snej@2:     the necessary source files and headers to your project. See the MYCrypto Xcode project,
snej@2:     which contains the minimal set of MYUtilities files needed to build MYUtilities. (That project
snej@2:     has its search paths set up to assume that MYUtilities is in a directory next to MYCrypto.)
snej@2: 
snej@2: \section download How To Get It
snej@2: 
snej@2:     <ul>
snej@2:     <li><a href="/hg/hgwebdir.cgi/MYCrypto/archive/tip.zip">Download the current source code</a>
snej@2:     <li>To check out the source code using <a href="http://selenic.com/mercurial">Mercurial</a>:
snej@2:     \verbatim hg clone /hg/hgwebdir.cgi/MYCrypto/ MYCrypto \endverbatim
snej@2:     <li>As described above, you'll also need to download or check out <a href="/hg/hgwebdir.cgi/MYUtilities">MYUtilities</a> and put it in 
snej@2:     a directory next to MYCrypto.
snej@2:     </ul>
snej@2: 
snej@2:     Or if you're just looking:
snej@2: 
snej@2:     <ul>
snej@2:     <li><a href="/hg/hgwebdir.cgi/MYCrypto/file/tip">Browse the source code</a>
snej@2:     <li><a href="annotated.html">Browse the class documentation</a>
snej@2:     </ul>
snej@2:     
snej@2:  */