mirror of https://github.com/acidanthera/audk.git
2e351cbe8e
https://bugzilla.tianocore.org/show_bug.cgi?id=1373 Replace BSD 2-Clause License with BSD+Patent License. This change is based on the following emails: https://lists.01.org/pipermail/edk2-devel/2019-February/036260.html https://lists.01.org/pipermail/edk2-devel/2018-October/030385.html RFCs with detailed process for the license change: V3: https://lists.01.org/pipermail/edk2-devel/2019-March/038116.html V2: https://lists.01.org/pipermail/edk2-devel/2019-March/037669.html V1: https://lists.01.org/pipermail/edk2-devel/2019-March/037500.html Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com> Reviewed-by: Bob Feng <bob.c.feng@intel.com> |
||
|---|---|---|
| .. | ||
| plugins | ||
| Readme.md | ||
| __init__.py | ||
| packagedoc_cli.py | ||
| packagedocapp.pyw | ||
Readme.md
Prerequisite Tools:
- Install Python 2.7.3 from https://www.python.org/download/releases/2.7.3/
- 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\
- Install DoxyGen 1.8.6 from https://sourceforge.net/projects/doxygen/files/rel-1.8.6/
- (Windows only) Install Htmlhelp tool from https://msdn.microsoft.com/en-us/library/windows/desktop/ms669985(v=vs.85).aspx
Limitation:
- 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:
- Enter src folder, double click "packagedocapp.pyw" or run command "python packagedocapp.pyw" to open the GUI.
- Make sure all the information in blank are correct.
- Click "Generate Package Document!" b) Run with command line:
- Open command line window
- Enter src folder, for example: "cd C:\PackageDocumentTools\src"
- Run "python packagedoc_cli.py --help" for detail command.