WP-CLI
-========
-wp-cli is a set of command-line tools for managing WordPress installations.
+======
-Where can I get more info?
---------------------------
-For documentation, usage, and examples, check out [wp-cli.org](http://wp-cli.org/).
+[](https://travis-ci.org/wp-cli/wp-cli)
-I'm running into troubles, what can I do?
------------------------------------------
+WP-CLI is a set of command-line tools for managing WordPress installations.
-To suggest a feature, report a bug, or general discussion, visit the [issues section](https://github.com/wp-cli/wp-cli/issues).
+Installation
+------------
+If you just want to use WP-CLI, see <http://wp-cli.org/#install>.
-Who's behind this thing?
-------------------------
+If you want to hack on WP-CLI, then clone this repository and run `./utils/dev-build`.
-We are [Andreas Creten](https://github.com/andreascreten) and [Cristi Burcă](https://github.com/scribu), friendly guys from Europe.
-
-A complete list of contributors can be found [here](https://github.com/wp-cli/wp-cli/contributors).
+Where can I get more info?
+--------------------------
+For documentation and examples, check out [wp-cli.org](http://wp-cli.org/) and the [wiki](https://github.com/wp-cli/wp-cli/wiki).
-Need even more info?
---------------------
-Read our [wiki](https://github.com/wp-cli/wp-cli/wiki) and find out how to create your own commands with our [commands cookbook](https://github.com/wp-cli/wp-cli/wiki/Commands-Cookbook).
+Also, WordPress Answers has a growing list of [WP-CLI related questions](http://wordpress.stackexchange.com/questions/tagged/wp-cli).
If you want to receive an email for every single commit, you can subscribe to the [wp-cli-commits](https://groups.google.com/forum/?fromgroups=#!forum/wp-cli-commits) mailing list.
-Running tests
--------------
-
-The tests use PHPUnit, which can be installed using [composer](http://getcomposer.org/).
-Once you've got composer installed, run:
+I'm running into troubles, what can I do?
+-----------------------------------------
+To suggest a feature, report a bug, or general discussion, visit the [issues section](https://github.com/wp-cli/wp-cli/issues).
- composer.phar install --dev
+If you're reporting a bug, please also post the output from `wp --info`.
-Before running the tests, you'll need a MySQL user called `wp_cli_test` with the
-password `password1` that has full privileges on the MySQL database `wp_cli_test`.
-Running the following as root in MySQL should do the trick:
+How can I help?
+---------------
+See [CONTRIBUTING.md](CONTRIBUTING.md).
- GRANT ALL PRIVILEGES ON wp_cli_test.* TO "wp_cli_test"@"localhost"
- IDENTIFIED BY "password1";
-
-Finally, to run the tests:
+Credits
+-------
+Besides the libraries defined in [composer.json](composer.json), we have used code or ideas from the following projects:
- vendor/bin/phpunit tests
+* [Drush](http://drush.ws/) for... a lot of things
+* [wpshell](http://code.trac.wordpress.org/browser/wpshell) for `wp shell`
+* [Regenerate Thumbnails](http://wordpress.org/plugins/regenerate-thumbnails/) for `wp media regenerate`
+* [Search-Replace-DB](https://github.com/interconnectit/Search-Replace-DB) for `wp search-replace`
+* [WordPress-CLI-Exporter](https://github.com/Automattic/WordPress-CLI-Exporter) for `wp export`
+* [WordPress-CLI-Importer](https://github.com/Automattic/WordPress-CLI-Importer) for `wp import`
+* [wordpress-plugin-tests](https://github.com/benbalter/wordpress-plugin-tests/) for `wp scaffold plugin-tests`
-Most tests install WordPress from scratch. Since this is pretty slow, you can
-use arguments to `phpunit` to only run the test that you're interested in:
+Who's behind this thing?
+------------------------
+We are [Andreas Creten](https://github.com/andreascreten) and [Cristi Burcă](https://github.com/scribu), friendly guys from Europe. For more info, see [Governance](https://github.com/wp-cli/wp-cli/wiki/Governance).
- vendor/bin/phpunit --filter test_function_you_want_to_run tests
+A complete list of contributors can be found [here](https://github.com/wp-cli/wp-cli/contributors).
OSDN Git Service
