Tamslo has uploaded a new change for review.

  https://gerrit.wikimedia.org/r/211707

Change subject: Updated README
......................................................................

Updated README

Change-Id: Ie749fc6d03094e2c2b793c5923cf18b5239a996d
---
M README.md
1 file changed, 50 insertions(+), 9 deletions(-)


  git pull 
ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/WikidataQualityConstraints
 refs/changes/07/211707/1

diff --git a/README.md b/README.md
index 7a02abe..87729be 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,56 @@
-# WikidataQualityConstraints
-[![Build 
Status](https://travis-ci.org/wikimedia/mediawiki-extensions-WikidataQualityConstraints.svg?branch=master)](https://travis-ci.org/wikimedia/mediawiki-extensions-WikidataQualityConstraints)
  [![Coverage 
Status](https://coveralls.io/repos/wikimedia/mediawiki-extensions-WikidataQualityConstraints/badge.svg)](https://coveralls.io/r/wikimedia/mediawiki-extensions-WikidataQualityConstraints)
  [![Scrutinizer Code 
Quality](https://scrutinizer-ci.com/g/wikimedia/mediawiki-extensions-WikidataQualityConstraints/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/wikimedia/mediawiki-extensions-WikidataQualityConstraints/?branch=master)
+# Wikibase Quality Constraints
+[![Build 
Status](https://travis-ci.org/wikimedia/mediawiki-extensions-WikidataQualityConstraints.svg?branch=master)]
+(https://travis-ci.org/wikimedia/mediawiki-extensions-WikidataQualityConstraints)
+[![Coverage 
Status](https://coveralls.io/repos/wikimedia/mediawiki-extensions-WikidataQualityConstraints/badge.svg)]
+(https://coveralls.io/r/wikimedia/mediawiki-extensions-WikidataQualityConstraints)
+[![Scrutinizer Code 
Quality](https://scrutinizer-ci.com/g/wikimedia/mediawiki-extensions-WikidataQualityConstraints/badges/quality-score.png?b=master)]
+(https://scrutinizer-ci.com/g/wikimedia/mediawiki-extensions-WikidataQualityConstraints/?branch=master)
 
-This is a complementary extension for the [Wikidata Quality 
extension](https://github.com/wikimedia/mediawiki-extensions-WikidataQuality.git).
-It performs constraint checks in Wikidata.
+This is a complementary extension for the [Wikibase Quality base extension]
+(https://github.com/wikimedia/mediawiki-extensions-WikidataQuality.git).  
+It performs constraint checks in Wikibase.
 
 ## Installation
 
-* Clone this repo into WikidataQuality/extensions
+_If you have already installed a complementary Wikibase Quality extension you 
can skip the first two steps and just
+add the repository (second entry in "repositories" and the required version 
(last entry in "require") to the
+composer.local.json._  
 
-`git clone 
https://github.com/wikimedia/mediawiki-extensions-WikidataQualityConstraints.git`
  
+* Create the file `composer.local.json` in the directory of your mediawiki 
installation.
 
-* Add `require_once __DIR__ . 
"/extensions/Wikidata/extensions/WikidataQuality/extensions/WikidataQualityConstraints/WikidataQualityConstraints.php";`
 to your LocalSettings.php
-* Run `php maintenance/update.php --quick` in your Mediawiki directory
-* Run `composer install` in the WikidataQualityConstraints directory
\ No newline at end of file
+* Add the following lines:
+```json
+{
+    "repositories": [
+        {
+            "type": "git",
+            "url": 
"https://gerrit.wikimedia.org/r/mediawiki/extensions/WikidataQuality";
+        },
+        {
+            "type": "git",
+            "url": 
"https://gerrit.wikimedia.org/r/mediawiki/extensions/WikidataQualityConstraints";
+        }
+    ],
+    "require": {
+        "wikibase/quality": "@dev",
+        "wikibase/wikibase": "@dev",
+        "wikibase/constraints": "1.x-dev"
+    }
+}
+```
+
+* Run `composer install`.
+
+* If not already done, add the following lines to your `LocalSettings.php` to 
enable Wikibase:
+```php
+$wgEnableWikibaseRepo = true;
+$wgEnableWikibaseClient = false;
+require_once "$IP/extensions/Wikibase/repo/ExampleSettings.php";
+```
+
+* Run `php maintenance/update.php --quick`.
+
+* Last but not least, you need to fill the constraints table - for that you 
need the
+[constraints from templates 
script](https://github.com/WikidataQuality/ConstraintsFromTemplates).  
+Follow the instruction in the README to create a csv file.  
+Run `php maintenance/runScript.php 
extensions/Constraints/maintenance/UpdateTable.php --csv-file 
<path_to_csv_file>`.
\ No newline at end of file

-- 
To view, visit https://gerrit.wikimedia.org/r/211707
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: Ie749fc6d03094e2c2b793c5923cf18b5239a996d
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/WikidataQualityConstraints
Gerrit-Branch: v1
Gerrit-Owner: Tamslo <tamaraslosa...@gmail.com>

_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

Reply via email to