mirror of
https://github.com/slawkens/myaac.git
synced 2025-11-04 09:46:23 +01:00
78 lines
2.5 KiB
Plaintext
78 lines
2.5 KiB
Plaintext
POT (PHP OTServ Toolkit) is a PHP toolkit for scripts that work with OTServ database.
|
|
|
|
|
|
===== About =====
|
|
|
|
|
|
This toolkit provides a way for PHP programmers that don't know SQL langauge to work with OTServ database.
|
|
|
|
For installation help check INSTALL file.
|
|
|
|
For usage tutorial/API documentation check http://otserv-aac.info/ or documentation.pdf file.
|
|
|
|
|
|
===== Contact =====
|
|
|
|
|
|
In case of any contact needed, please use following e-mail address: wrzasq@gmail.com.
|
|
|
|
|
|
===== Files =====
|
|
|
|
|
|
classes/ - POT class files.
|
|
examples/ - example files for learning.
|
|
tutorials/ - phpDocumentor directory.
|
|
CHANGELOG - changes history.
|
|
INSTALL - installation tutorial.
|
|
LICENSE - POT license (GNU LGPL v3), if you don't accept it - don't use any of those scripts.
|
|
LICENSE.PEAR.CRYPT_RSA - PEAR::Crypt_RSA (PHP License, version 3.0), if you don't accept it - don't use any of those scripts.
|
|
LICENSE.PEAR.CRYPT_XTEA - PEAR::Crypt_XTEA (PHP License, version 2.02), if you don't accept it - don't use any of those scripts.
|
|
NEWS - changes in current release.
|
|
README - this readme file.
|
|
RULES - rules to be followed during developing contributed code.
|
|
Makefile - make input, for documentation generation.
|
|
POT.psf - PHK Package Specification File.
|
|
documentation.pdf - phpDocumentor-generater documentation in PDF format.
|
|
compat.php - compatibility assurance library.
|
|
phar.php - PHAR package build script.
|
|
test.php - phpUnit test suite.
|
|
|
|
|
|
===== Makefile =====
|
|
|
|
|
|
Makefile contains some targets for make that can help in development. Makefile requires following command-line commands:
|
|
|
|
php: PHP CLI interface.
|
|
phpdoc: phpDocumentor.
|
|
phpunit: PHPUnit testing framework.
|
|
PHK_Creator.phk: this is file which you download from http://phk.tekwire.net/.
|
|
|
|
To build PHAR package you will need PECL PHAR extension installed.
|
|
|
|
Possible targets:
|
|
|
|
all: default one, runs all other targets (in order: clean, check, documentation, pdf, online, test, package, manual, phk, phar).
|
|
clean: deletes documentation.
|
|
check: checks syntax of all PHP files.
|
|
documentation: generates HTML documentation.
|
|
pdf: generates PDF documentation.
|
|
online: OTServ-AAC website documentation template used.
|
|
test: runs test suite.
|
|
package: creates pot.tar.gz file for distribution purposes.
|
|
manual: creates documentation.tar.gz file for distribution purposes.
|
|
phk: creates POT.phk distribution package.
|
|
phar: creates POT.phar distribution package.
|
|
|
|
For more readable output of phpUnit test run:
|
|
php test.php
|
|
|
|
|
|
===== Credits =====
|
|
|
|
|
|
* Wrzasq <wrzasq@gmail.com> - project initiator, main developer.
|
|
|
|
For more info see AUTHORS file in OTServ tree.
|