correct an example which had no chance of working

[wxWidgets.git] / utils / screenshotgen / README.txt

diff --git a/utils/screenshotgen/README.txt b/utils/screenshotgen/README.txt
index 8f278eeb28361db75c2956afac521f2d246ef66c..09220461133b2d8ef030ceb68487f7bf09f897db 100644 (file)
--- a/utils/screenshotgen/README.txt
+++ b/utils/screenshotgen/README.txt
@@ -5,15 +5,47 @@
  Author: Utensil Candel (Email: UtensilCandel at GMail dot com)
  Licence: wxWidgets Licence
 
  Author: Utensil Candel (Email: UtensilCandel at GMail dot com)
  Licence: wxWidgets Licence
 

- Thanks: Auria, frm, tierra, Jorg (these are the names they use on the wxWidgets forum)
+ Thanks: Francesco Montorsi, Bryan Petty, Auria, Jorg and wxForum

 
 

- This utility is developed to generate automatically screenshots of the wxWidgets
+ This utility is developed to automatically generate screenshots of the wxWidgets

  controls for use in wxWidgets documentation.
 
  controls for use in wxWidgets documentation.
 

- The main part of the GUI (guiframe.h/guiframe.cpp) is generated with wxFormBuilder
- (http://wxformbuilder.org/), a powerful cross-platform open-source RAD tool.
- To add a control that wxFormBuilder doesn't support directly, "custom controls"
- feature of wxFormBuilder has been used.
+ The main part of the GUI (guiframe.h/guiframe.cpp) was generated with wxFormBuilder
+ (http://wxformbuilder.org/), a powerful cross-platform open-source RAD tool. Now its
+ trace is removed so we can maintain the code without using it.

 
 

- Please DO NOT modify guiframe.h/guiframe.cpp; modify the code in the wxFormBuilder
- project file, instead.
+
+===User Guide: How To Use==
+
+The screenshots will be generated under sub-directory "screenshots" silently.
+Please monitor this folder before taking screenshots using "File->Open screenshots folder".
+
+1) The menu "Capture->Full screen" can take a screeshot for the fullscreen. It's designed
+for testing purpose only.
+
+2) The menu "Capture->Regions<Begin>" and "Capture->Regions<End>" was the semi-auto part,
+and now it's deprecated and will be removed soon.
+
+3) Finnally the full-auto mode: "Capture->Capture All" or Ctrl+Alt+A, follow the instructions
+ and all the screenshots will be generated correctly under the subdirectory "screenshots".
+
+ ==Developer Guide: How To Add More Controls==
+
+ (Coming soon)
+
+ ==To-do List==
+
+ 1) Remove wxAuiNoteBook related lagacy codes, which is no longer useful;
+
+ 2) Refactor the GUI code, which was generated by wxFormBuilder, but it's messy for human to
+ maintain;
+
+ 3) Remove the class CtrlMaskOut since semi-auto part of this utility is no longer needed.
+
+ 4) Clearify the interface of class AutoCaptureMechanism and document how to add a new control
+ that needs to take screenshots, and how to adjust it to avoid bugs in wxRTTI system and
+ wxWindow::GetScreenRect();
+
+ 5) Make this utility easier to configure;
+
+ 6) Add test functionality to confirm bugs in wxRTTI system and wxWindow::GetScreenRect().