docs: readme

This commit is contained in:
mattias 2021-10-30 11:56:47 +02:00
parent d7ed558c61
commit f8af491a06
2 changed files with 5 additions and 1 deletions

View File

@ -13,6 +13,8 @@ Build build_lcl_docs.lpi
./build_lcl_docs --fpdoc /path/to/fpc/trunk/utils/fpdoc/fpdoc --fpcdocs=../chm --outfmt chm --footer locallclfooter.xml
Note: It is recommened to use the fpdoc from fpc trunk. If you are unlucky and got a buggy revision, you can try with the released fpdoc.
For Windows:
Build the project build_lcl_docs.lpi, fix the PATH in the build_html.bat batch

View File

@ -6,7 +6,9 @@
# Before running this file, first compile the project build_lcl_docs.lpi
#
# In order to link to RTL and FCL, place rtl.xct and fcl.xct in ../chm/
#
#
# This uses the fpdoc in PATH. See README.txt
#
./build_lcl_docs --fpcdocs=../chm --outfmt html