jenkins-bot has submitted this change and it was merged. Change subject: Add docs to readme ......................................................................
Add docs to readme Change-Id: I0a7acaae664545084582b45300381b22d8b13637 --- M README.md 1 file changed, 80 insertions(+), 8 deletions(-) Approvals: Addshore: Looks good to me, approved jenkins-bot: Verified diff --git a/README.md b/README.md index 39b27e5..6fa1815 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,8 @@ +# Wikibase QueryEngine + +[](https://packagist.org/packages/wikibase/query-engine) +[](https://packagist.org/packages/wikibase/query-engine) [](http://travis-ci.org/wikimedia/mediawiki-extensions-WikibaseQueryEngine) - -These is the readme file for the Wikibase QueryEngine component. - -Extension page on mediawiki.org: https://www.mediawiki.org/wiki/Extension:Wikibase_QueryEngine -Latest version of the readme file: https://gerrit.wikimedia.org/r/gitweb?p=mediawiki/extensions/WikibaseQueryEngine.git;a=blob;f=README.md - -About -===== Component containing query answering code for [Ask](https://www.mediawiki.org/wiki/Extension:Ask) @@ -14,3 +10,79 @@ [Wikibase](https://www.mediawiki.org/wiki/Wikibase) entities. +## Requirements + +* PHP 5.3 or later +* [DataValues](https://www.mediawiki.org/wiki/Extension:DataValues) 0.1 or later +* [Ask](https://github.com/wikimedia/mediawiki-extensions-Ask/blob/master/README.md) 0.1 or later +* [Wikibase DataModel](https://www.mediawiki.org/wiki/Extension:Wikibase_DataModel) 0.4 or later +* [Wikibase Database](https://www.mediawiki.org/wiki/Extension:WikibaseDatabase) 0.1 or later + +## Installation + +You can use [Composer](http://getcomposer.org/) to download and install +this package as well as its dependencies. Alternatively you can simply clone +the git repository and take care of loading yourself. + +### Composer + +To add this package as a local, per-project dependency to your project, simply add a +dependency on `wikibase/query-engine` to your project's `composer.json` file. +Here is a minimal example of a `composer.json` file that just defines a dependency on +Wikibase QueryEngine 1.0: + + { + "require": { + "wikibase/query-engine": "1.0.*" + } + } + +### Manual + +Get the Wikibase QueryEngine code, either via git, or some other means. Also get all dependencies. +You can find a list of the dependencies in the "require" section of the composer.json file. +Load all dependencies and the load the Wikibase QueryEngine library by including its entry point: +WikibaseQueryEngine.php. + +## Usage + +The public interfaces in this component are everything directly in the Wikibase\QueryEngine. +Other classes and interfaces are typically package private, and should not be used or known +about outside of the package. Each store implementation has its own list of additional public +classes. + +### SQLStore + +Public classes of the SQLStore: + +* SQLStore\Store +* SQLStore\StoreConfig + + + +Constructing an SQLStore: + + + +## SQLstore internal structure + + + +## Tests + +This library comes with a set up PHPUnit tests that cover all non-trivial code. You can run these +tests using the PHPUnit configuration file found in the root directory. The tests can also be run +via TravisCI, as a TravisCI configuration file is also provided in the root directory. + +## Authors + +Ask has been written by [Jeroen De Dauw](https://www.mediawiki.org/wiki/User:Jeroen_De_Dauw) +as [Wikimedia Germany](https://wikimedia.de) employee for the [Wikidata project](https://wikidata.org/). + +## Links + +* [Wikibase QueryEngine on Packagist](https://packagist.org/packages/wikibase/query-engine) +* [Wikibase QueryEngine on Ohloh](https://www.ohloh.net/p/wikibasequeryengine/) +* [Wikibase QueryEngine on MediaWiki.org](https://www.mediawiki.org/wiki/Extension:Wikibase_QueryEngine) +* [TravisCI build status](https://travis-ci.org/wikimedia/mediawiki-extensions-WikibaseQueryEngine) +* [Latest version of the readme file](https://github.com/wikimedia/mediawiki-extensions-WikibaseQueryEngine/blob/master/README.md) \ No newline at end of file -- To view, visit https://gerrit.wikimedia.org/r/73976 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I0a7acaae664545084582b45300381b22d8b13637 Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/extensions/WikibaseQueryEngine Gerrit-Branch: master Gerrit-Owner: Jeroen De Dauw <[email protected]> Gerrit-Reviewer: Addshore <[email protected]> Gerrit-Reviewer: jenkins-bot _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
