projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 7ccc9c95 | 1 | Prerequisite Tools:\r |
| 9d7e1e56 YF |
2 | 1. Install Python 3.6.6 from https://www.python.org/downloads/release/python-366/\r |
| 3 | 2. Install wxPython 4.0.3 from https://pypi.org/project/wxPython/#files\r | |
| 7ccc9c95 YZ |
4 | generally the libraries will be installed at python's subfolder, for example in windows: c:\python27\Lib\site-packages\\r |
| 5 | 3. Install DoxyGen 1.8.6 from https://sourceforge.net/projects/doxygen/files/rel-1.8.6/\r | |
| 6 | 4. (Windows only) Install Htmlhelp tool from https://msdn.microsoft.com/en-us/library/windows/desktop/ms669985(v=vs.85).aspx\r | |
| 7 | \r | |
| 8 | Limitation:\r | |
| 9 | 1. Current tool doesn't work on latest wxPython and DoxyGen tool. Please use the sepecific version in above.\r | |
| 10 | \r | |
| 11 | Run the Tool:\r | |
| 12 | a) Run with GUI:\r | |
| 13 | 1. Enter src folder, double click "packagedocapp.pyw" or run command "python packagedocapp.pyw" to open the GUI.\r | |
| 14 | 2. Make sure all the information in blank are correct.\r | |
| 15 | 3. Click "Generate Package Document!"\r | |
| 16 | b) Run with command line:\r | |
| 17 | 1. Open command line window\r | |
| 18 | 2. Enter src folder, for example: "cd C:\PackageDocumentTools\src"\r | |
| 19 | 3. Run "python packagedoc_cli.py --help" for detail command.\r |