maindocs.h
author Jens Alfke <jens@mooseyard.com>
Fri Aug 07 11:24:53 2009 -0700 (2009-08-07)
changeset 28 54b373aa65ab
permissions -rw-r--r--
Fixed iPhone OS build. (issue 3)
     1 //
     2 //  maindocs.h
     3 //  MYCrypto
     4 //
     5 //  Created by Jens Alfke on 4/06/09.
     6 //  Copyright 2009 Jens Alfke. All rights reserved.
     7 //
     8 // This file just contains the Doxygen comments that generate the main (index.html) page content.
     9 
    10 
    11 /*! \mainpage MYCrypto: Mooseyard Cryptography Library
    12  
    13     <center><b>By <a href="/Jens/">Jens Alfke</a></b></center>
    14 
    15 \section intro_sec Introduction
    16  
    17     MYCrypto is a set of Objective-C cryptography classes for Cocoa applications on Mac OS X and iPhone.
    18     
    19     <a href="annotated.html">Browse the class documentation.</a>
    20  
    21 \section license License
    22  
    23  MYCrypto is released under a BSD license, which means you can freely use it in open-source
    24  or commercial projects, provided you give credit in your documentation or About box.
    25    
    26 \section config Configuration
    27  
    28     MYCrypto requires Mac OS X 10.5 or later, since it uses Objective-C 2 features like
    29     properties and for...in loops.
    30  
    31     MYCrypto uses my <a href="/hg/hgwebdir.cgi/MYUtilities">MYUtilities</a> library. You'll need to have downloaded that library, and added
    32     the necessary source files and headers to your project. See the MYCrypto Xcode project,
    33     which contains the minimal set of MYUtilities files needed to build MYUtilities. (That project
    34     has its search paths set up to assume that MYUtilities is in a directory next to MYCrypto.)
    35 
    36 \section download How To Get It
    37 
    38     <ul>
    39     <li><a href="/hg/hgwebdir.cgi/MYCrypto/archive/tip.zip">Download the current source code</a>
    40     <li>To check out the source code using <a href="http://selenic.com/mercurial">Mercurial</a>:
    41     \verbatim hg clone /hg/hgwebdir.cgi/MYCrypto/ MYCrypto \endverbatim
    42     <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 
    43     a directory next to MYCrypto.
    44     </ul>
    45 
    46     Or if you're just looking:
    47 
    48     <ul>
    49     <li><a href="/hg/hgwebdir.cgi/MYCrypto/file/tip">Browse the source code</a>
    50     <li><a href="annotated.html">Browse the class documentation</a>
    51     </ul>
    52     
    53  */