MediaWiki 1.30.2

[autoinstallsdev/mediawiki.git] / vendor / README.md

diff --git a/vendor/README.md b/vendor/README.md
new file mode 100644 (file)
index 0000000..4009e29
--- /dev/null
+++ b/vendor/README.md
@@ -0,0 +1,31 @@
+MediaWiki-Vendor
+================
+
+[Composer] managed libraries required or recommended for use with [MediaWiki].
+This repository is maintained for use on the Wikimedia Foundation production
+and testing clusters, but may be useful for anyone wishing to avoid directly
+managing MediaWiki dependencies with Composer.
+
+
+Usage
+-----
+
+Checkout this library into $IP/vendor using `git clone <URL>` or add the
+repository as a git submodule using `git submodule add <URL> vendor` followed
+by `git submodule update --init`.
+
+
+Adding or updating libraries
+----------------------------
+
+0. Read the [documentation] on the process for adding new libraries.
+1. Ensure you're using the 1.4.1 version of composer via `composer --version`.
+2. Edit the composer.json file to add/update the libraries you want to change.
+3. Run `composer update --no-dev` to download files and update the autoloader.
+4. Add and commit changes as a gerrit patch.
+5. Review and merge changes.
+
+
+[Composer]: https://getcomposer.org/
+[MediaWiki]: https://www.mediawiki.org/wiki/MediaWiki
+[documentation]: https://www.mediawiki.org/wiki/Manual:External_libraries