tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
audk/BaseTools/Scripts/PackageDocumentTools
History
Mikhail Krichanov a828c6cedf Drop support for the TE format 2023-12-20 14:00:19 +03:00
..
plugins Drop support for the TE format 2023-12-20 14:00:19 +03:00
Readme.md Revert BaseTools: PYTHON3 migration 2018-10-15 08:29:14 +08:00
__init__.py BaseTools: Replace BSD License with BSD+Patent License 2019-04-09 09:10:20 -07:00
packagedoc_cli.py BaseTools: Replace BSD License with BSD+Patent License 2019-04-09 09:10:20 -07:00
packagedocapp.pyw BaseTools: Replace BSD License with BSD+Patent License 2019-04-09 09:10:20 -07:00

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.