Antoine Cœur 2d53d54a5b BaseTools: Fix various typos 4 years ago
..
plugins 2d53d54a5b BaseTools: Fix various typos 4 years ago
Readme.md 1ccc4d895d Revert BaseTools: PYTHON3 migration 5 years ago
__init__.py 2e351cbe8e BaseTools: Replace BSD License with BSD+Patent License 5 years ago
packagedoc_cli.py 2e351cbe8e BaseTools: Replace BSD License with BSD+Patent License 5 years ago
packagedocapp.pyw 2e351cbe8e BaseTools: Replace BSD License with BSD+Patent License 5 years ago

Readme.md

Prerequisite Tools:

  1. Install Python 2.7.3 from https://www.python.org/download/releases/2.7.3/
  2. Install wxPython 2.8.12.1 from https://sourceforge.net/projects/wxpython/files/wxPython/2.8.12.1/ generally the libraries will be installed at python’s subfolder, for example in windows: c:\python27\Lib\site-packages\
  3. Install DoxyGen 1.8.6 from https://sourceforge.net/projects/doxygen/files/rel-1.8.6/
  4. (Windows only) Install Htmlhelp tool from https://msdn.microsoft.com/en-us/library/windows/desktop/ms669985(v=vs.85).aspx

Limitation:

  1. Current tool doesn’t work on latest wxPython and DoxyGen tool. Please use the sepecific version in above.

Run the Tool: a) Run with GUI:

  1. Enter src folder, double click «packagedocapp.pyw» or run command «python packagedocapp.pyw» to open the GUI.
  2. Make sure all the information in blank are correct.
  3. Click «Generate Package Document!» b) Run with command line:
  4. Open command line window
  5. Enter src folder, for example: «cd C:\PackageDocumentTools\src»
  6. Run «python packagedoc_cli.py –help» for detail command.