chiark - git - matthewv - flashcards/blob - README

   1                               FlashCards
   2
   3               A LaTeX Class for Typesetting Flash Cards.
   4
   5                                 v1.0.1
   6                              30 July 2010
   7
   8                  Alexander M. Budge <ambudge@mit.edu>
   9 (bug-fixes from v1.0.0 to v1.0.1 by Matthew Vernon <matthew@debian.org>)
  10
  11 ----------------------------------------------------------------------
  12                              DESCRIPTION
  13
  14 The FlashCards  class provides for  the typesetting of flash  cards in
  15 LaTeX2e.  By flash card, I mean a two sided card which has a prompt or
  16 a question  on one  side and the  response or  the answer on  the flip
  17 (back) side.  Flash  cards come in many sizes  depending on the nature
  18 of  the information  they contain.  In particular,  I like  using both
  19 3x5'' (index  cards) and 2x3.5'' (business cards)  which are available
  20 in perforated sheets suitable for printing or copying onto.
  21
  22
  23 ----------------------------------------------------------------------
  24                        CONTENTS OF DISTRIBUTION
  25
  26 The package files:
  27   README                        This file
  28   COPYING                       The GNU Public License
  29   flashcards.dtx                Documentation and source code
  30   flahcards.ins                 Installation driver
  31
  32 These files generate:
  33   flashcards.cls                FlashCards class source code
  34   avery5371.cfg                 Avery business cards configuration
  35   avery5388.cfg                 Avery index cards configuration
  36   samplecards.tex               Sample document
  37
  38
  39 ----------------------------------------------------------------------
  40                              INSTALLATION
  41
  42 To generate the documentation, run LaTeX on the file "flashcards.dtx".
  43
  44 To generate the class file, sample document and configuration files,
  45 run LaTeX on the file "flashcards.ins".  Place the class file (ending
  46 with '.cls') and the configuration files (ending with '.cfg') in your
  47 LaTeX path.
  48
  49
  50 ----------------------------------------------------------------------
  51                        DISTRIBUTION CONDITIONS
  52
  53      FlashCards LaTeX2e Class for Typesetting Double Sided Cards
  54        Copyright (C) 2000  Alexander M. Budge <ambudge@mit.edu>
  55
  56 This program is  free software; you can redistribute  it and/or modify
  57 it under the  terms of the GNU General Public  License as published by
  58 the Free Software Foundation; either  version 2 of the License, or (at
  59 your option) any later version.
  60
  61 This program  is distributed in the  hope that it will  be useful, but
  62 WITHOUT   ANY  WARRANTY;   without  even   the  implied   warranty  of
  63 MERCHANTABILITY  or FITNESS  FOR A  PARTICULAR PURPOSE.   See  the GNU
  64 General Public License for more details.
  65
  66 You  should have received  a copy  of the  GNU General  Public License
  67 along with this program (the file  COPYING); if not, write to the Free
  68 Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  69
  70
  71