geckon01/php-qrcode
1
0
Fork 0
mirror of https://github.com/chillerlan/php-qrcode.git synced 2026-09-12 18:56:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

✨

Browse Source
This commit is contained in:
codemasher
2020-04-06 19:07:16 +02:00
parent a4ff33a171
commit 90775f1943
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/Readme.md
+13
View File
@@ -0,0 +1,13 @@
# Auto generated API documentation
The API documentation can be auto generated with [phpDocumentor](https://www.phpdoc.org/).
There is an [online version available](https://chillerlan.github.io/php-qrcode/) via the [gh-pages branch](https://github.com/chillerlan/php-qrcode/tree/gh-pages) that is [automatically deployed](https://github.com/chillerlan/php-qrcode/deployments) on each push to master.
Locally created docs will appear in this directory. If you'd like to create local docs, please follow these steps:
- [download phpDocumentor](https://github.com/phpDocumentor/phpDocumentor/releases) v3+ as .phar archive
- run it in the repository root directory:
- on Windows `c:\path\to\php.exe c:\path\to\phpDocumentor.phar --config=phpdoc.xml`
- on Linux just `php /path/to/phpDocumentor.phar --config=phpdoc.xml`
- open [index.html](./index.html) in a browser
- profit!