jenkins-bot has submitted this change and it was merged.
Change subject: Add basic readme
......................................................................
Add basic readme
Change-Id: I2b633bf6246c4f38a9a1b00badf2e57aa1543e02
---
A README.md
1 file changed, 37 insertions(+), 0 deletions(-)
Approvals:
Aude: Looks good to me, approved
jenkins-bot: Verified
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5aa4f2b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+Wikidata 'Build' Git Repository
+=========
+
+This git repo contains everything you need to deploy Wikidata (Wikibase and
all of its dependencies). This repository uses git sumbodules to pull in
dependencies.
+
+## Installation
+
+ - Pull the Git Repository
+ - Run 'git submodule update'
+
+Add the following line to your LocalSettings.php
+```php
+require_once("$IP/extensions/Wikidata/Wikidata.php");
+```
+This entry point in turn loads all other entry points
+
+## Configuration
+
+Wikibase itself needs to be configured, see the below links
+
+ - https://www.mediawiki.org/wiki/Extension:Wikibase_Repository
+ - https://www.mediawiki.org/wiki/Extension:Wikibase_Client
+
+Using this repo provides extra options to allow you to choose to deploy the
Repo and/or Client.
+
+```php
+// Load the Repo Extension (default false)
+$wmgUseWikibaseRepo = true;
+// Load the Client Extension (default false)
+$wmgUseWikibaseClient = true;
+```
+
+## Maintanence Scripts
+
+The Maintanence scripts help within this repo will not work if you do not have
the environment variable **MW_INSTALL_PATH** defined.
+
+If you do not and can not define this variable please use the
**runScript.php** maintanence script within mediawiki core (see comments in
that file for instructions)
--
To view, visit https://gerrit.wikimedia.org/r/95387
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I2b633bf6246c4f38a9a1b00badf2e57aa1543e02
Gerrit-PatchSet: 4
Gerrit-Project: mediawiki/extensions/Wikidata
Gerrit-Branch: master
Gerrit-Owner: Addshore <addshorew...@gmail.com>
Gerrit-Reviewer: Addshore <addshorew...@gmail.com>
Gerrit-Reviewer: Aude <aude.w...@gmail.com>
Gerrit-Reviewer: Daniel Kinzler <daniel.kinz...@wikimedia.de>
Gerrit-Reviewer: Jeroen De Dauw <jeroended...@gmail.com>
Gerrit-Reviewer: Lydia Pintscher <lydia.pintsc...@wikimedia.de>
Gerrit-Reviewer: Tobias Gritschacher <tobias.gritschac...@wikimedia.de>
Gerrit-Reviewer: jenkins-bot
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
