-
Notifications
You must be signed in to change notification settings - Fork 134
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
REBASE: Fixed markdown lint errors in ReadMe.md files in Basetools
- Loading branch information
1 parent
90fb2a0
commit cf1862f
Showing
3 changed files
with
218 additions
and
149 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,25 @@ | ||
# Package Document Tool | ||
|
||
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/ | ||
|
||
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 | ||
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. | ||
|
||
* 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: | ||
1. Open command line window | ||
2. Enter src folder, for example: "cd C:\PackageDocumentTools\src" | ||
3. Run "python packagedoc_cli.py --help" for detail command. | ||
|
||
* 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!" | ||
|
||
* Run with command line: | ||
1. Open command line window | ||
2. Enter src folder, for example: "cd C:\PackageDocumentTools\src" | ||
3. Run "python packagedoc_cli.py --help" for detail command. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.