src/TortoiseGitBlame/ReadMe.txt

   1 ================================================================================\r
   2     MICROSOFT FOUNDATION CLASS LIBRARY : TortoiseGitBlame Project Overview\r
   3 ===============================================================================\r
   4 \r
   5 The application wizard has created this TortoiseGitBlame application for\r
   6 you.  This application not only demonstrates the basics of using the Microsoft\r
   7 Foundation Classes but is also a starting point for writing your application.\r
   8 \r
   9 This file contains a summary of what you will find in each of the files that\r
  10 make up your TortoiseGitBlame application.\r
  11 \r
  12 TortoiseGitBlame.vcproj\r
  13     This is the main project file for VC++ projects generated using an application wizard.\r
  14     It contains information about the version of Visual C++ that generated the file, and\r
  15     information about the platforms, configurations, and project features selected with the\r
  16     application wizard.\r
  17 \r
  18 TortoiseGitBlame.h\r
  19     This is the main header file for the application.  It includes other\r
  20     project specific headers (including Resource.h) and declares the\r
  21     CTortoiseGitBlameApp application class.\r
  22 \r
  23 TortoiseGitBlame.cpp\r
  24     This is the main application source file that contains the application\r
  25     class CTortoiseGitBlameApp.\r
  26 \r
  27 TortoiseGitBlame.rc\r
  28     This is a listing of all of the Microsoft Windows resources that the\r
  29     program uses.  It includes the icons, bitmaps, and cursors that are stored\r
  30     in the RES subdirectory.  This file can be directly edited in Microsoft\r
  31     Visual C++. Your project resources are in 1033.\r
  32 \r
  33 res\TortoiseGitBlame.ico\r
  34     This is an icon file, which is used as the application's icon.  This\r
  35     icon is included by the main resource file TortoiseGitBlame.rc.\r
  36 \r
  37 res\TortoiseGitBlame.rc2\r
  38     This file contains resources that are not edited by Microsoft\r
  39     Visual C++. You should place all resources not editable by\r
  40     the resource editor in this file.\r
  41 \r
  42 /////////////////////////////////////////////////////////////////////////////\r
  43 \r
  44 For the main frame window:\r
  45     The project includes a standard MFC interface.\r
  46 \r
  47 MainFrm.h, MainFrm.cpp\r
  48     These files contain the frame class CMainFrame, which is derived from\r
  49     CFrameWnd and controls all SDI frame features.\r
  50 \r
  51 res\Toolbar.bmp\r
  52     This bitmap file is used to create tiled images for the toolbar.\r
  53     The initial toolbar and status bar are constructed in the CMainFrame\r
  54     class. Edit this toolbar bitmap using the resource editor, and\r
  55     update the IDR_MAINFRAME TOOLBAR array in TortoiseGitBlame.rc to add\r
  56     toolbar buttons.\r
  57 /////////////////////////////////////////////////////////////////////////////\r
  58 \r
  59 The application wizard creates one document type and one view:\r
  60 \r
  61 TortoiseGitBlameDoc.h, TortoiseGitBlameDoc.cpp - the document\r
  62     These files contain your CTortoiseGitBlameDoc class.  Edit these files to\r
  63     add your special document data and to implement file saving and loading\r
  64     (via CTortoiseGitBlameDoc::Serialize).\r
  65 \r
  66 TortoiseGitBlameView.h, TortoiseGitBlameView.cpp - the view of the document\r
  67     These files contain your CTortoiseGitBlameView class.\r
  68     CTortoiseGitBlameView objects are used to view CTortoiseGitBlameDoc objects.\r
  69 \r
  70 \r
  71 \r
  72 \r
  73 /////////////////////////////////////////////////////////////////////////////\r
  74 \r
  75 Help Support:\r
  76 \r
  77 hlp\TortoiseGitBlame.hhp\r
  78     This file is a help project file. It contains the data needed to\r
  79     compile the help files into a .chm file.\r
  80 \r
  81 hlp\TortoiseGitBlame.hhc\r
  82     This file lists the contents of the help project.\r
  83 \r
  84 hlp\TortoiseGitBlame.hhk\r
  85     This file contains an index of the help topics.\r
  86 \r
  87 hlp\afxcore.htm\r
  88     This file contains the standard help topics for standard MFC\r
  89     commands and screen objects. Add your own help topics to this file.\r
  90 \r
  91 hlp\afxprint.htm\r
  92     This file contains the help topics for the printing commands.\r
  93 \r
  94 makehtmlhelp.bat\r
  95     This file is used by the build system to compile the help files.\r
  96 \r
  97 hlp\Images\*.gif\r
  98     These are bitmap files required by the standard help file topics for\r
  99     Microsoft Foundation Class Library standard commands.\r
 100 \r
 101 \r
 102 /////////////////////////////////////////////////////////////////////////////\r
 103 \r
 104 Other Features:\r
 105 \r
 106 ActiveX Controls\r
 107     The application includes support to use ActiveX controls.\r
 108 \r
 109 Printing and Print Preview support\r
 110     The application wizard has generated code to handle the print, print setup, and print preview\r
 111     commands by calling member functions in the CView class from the MFC library.\r
 112 \r
 113 /////////////////////////////////////////////////////////////////////////////\r
 114 \r
 115 Other standard files:\r
 116 \r
 117 StdAfx.h, StdAfx.cpp\r
 118     These files are used to build a precompiled header (PCH) file\r
 119     named TortoiseGitBlame.pch and a precompiled types file named StdAfx.obj.\r
 120 \r
 121 Resource.h\r
 122     This is the standard header file, which defines new resource IDs.\r
 123     Microsoft Visual C++ reads and updates this file.\r
 124 \r
 125 TortoiseGitBlame.manifest\r
 126         Application manifest files are used by Windows XP to describe an applications\r
 127         dependency on specific versions of Side-by-Side assemblies. The loader uses this\r
 128         information to load the appropriate assembly from the assembly cache or private\r
 129         from the application. The Application manifest  maybe included for redistribution\r
 130         as an external .manifest file that is installed in the same folder as the application\r
 131         executable or it may be included in the executable in the form of a resource.\r
 132 /////////////////////////////////////////////////////////////////////////////\r
 133 \r
 134 Other notes:\r
 135 \r
 136 The application wizard uses "TODO:" to indicate parts of the source code you\r
 137 should add to or customize.\r
 138 \r
 139 If your application uses MFC in a shared DLL, you will need\r
 140 to redistribute the MFC DLLs. If your application is in a language\r
 141 other than the operating system's locale, you will also have to\r
 142 redistribute the corresponding localized resources MFC90XXX.DLL.\r
 143 For more information on both of these topics, please see the section on\r
 144 redistributing Visual C++ applications in MSDN documentation.\r
 145 \r
 146 /////////////////////////////////////////////////////////////////////////////\r