-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4a69ef4
commit 3c89c60
Showing
1 changed file
with
56 additions
and
2 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,2 +1,56 @@ | ||
# DocumentPHP | ||
Documentation Generator for PHP | ||
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT) | ||
|
||
DocumentPHP | ||
============= | ||
|
||
What is DocumentPHP? | ||
---------------------- | ||
|
||
DocumentPHP is an application that is capable of analyzing your PHP source code and fetch the files for making API Documentation Data. | ||
|
||
DocumentPHP v0.0.2 (Test) | ||
------------------------------------ | ||
|
||
v0.0.2 is the developmental release. | ||
|
||
Features | ||
-------- | ||
|
||
DocumentPHP supports the following: | ||
|
||
* *PHP 5.4+ compatible* | ||
* *Easy to Use*, you can create your Opencart Documentation Easily. | ||
|
||
Installation | ||
------------ | ||
|
||
DocumentPHP requires PHP 5.4 or higher to run. | ||
However, code of earlier PHP versions can be analyzed. | ||
|
||
All templates provided with DocumentPHP have support for Class diagrams based on the read code base. | ||
Rendering is done on Classes. | ||
|
||
Install DocumentPHP: | ||
|
||
### Via Composer | ||
|
||
There is a DocumentPHP composer package that you can use to install DocumentPHP. | ||
|
||
How to use DocumentPHP? | ||
------------------------- | ||
|
||
To run DocumentPHP after installing via composer and copy the main.php file and make changes accordingly ( file attached in this repo ). | ||
Note- Make Sure the main.php file is at the root location. | ||
|
||
Contact | ||
------- | ||
|
||
Reaching out to us is easy, and can be done with: | ||
|
||
* Twitter: https://twitter.com/codeeshop | ||
* Website: https://www.codeeshop.com | ||
* GitHub: https://github.com/codeeshop-oc/document-php | ||
* E-mail: codeeshop2211@gmail.com | ||
|
||
[Composer]: https://getcomposer.org/ | ||
[codeeshop mail]: mailto:codeeshop2211@gmail.com |