Skip to content

Commit 3a1620b

Browse files
README.md changes from the master branch: support section, notes on assigning issues, moving usage up, add links to old drupal.org issues.
1 parent 91bc8e4 commit 3a1620b

File tree

1 file changed

+46
-38
lines changed

1 file changed

+46
-38
lines changed

README.md

Lines changed: 46 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -5,28 +5,56 @@ Drush is a command line shell and Unix scripting interface for Drupal. If you a
55

66
Drush core ships with lots of useful commands for interacting with code like modules/themes/profiles. Similarly, it runs update.php, executes sql queries and DB migrations, and misc utilities like run cron or clear cache.
77

8-
To contribute to Drush, see [/CONTRIBUTING.md](CONTRIBUTING.md)
9-
108
DRUSH VERSIONS
119
--------------
1210

13-
Each version of Drush supports multiple Drupal versions. Drush 6 is the recommended version.
11+
Each version of Drush supports multiple Drupal versions. Drush 6 is recommended version.
12+
13+
Drush Version | Branch | PHP | Compatible Drupal versions | Code Status
14+
------------- | ------ | --- | -------------------------- | -----------
15+
Drush 7 | [master](https://travis-ci.org/drush-ops/drush) | 5.3.3+ | D6, D7, D8 | <img src="https://travis-ci.org/drush-ops/drush.png?branch=master">
16+
Drush 6 | [6.x](https://travis-ci.org/drush-ops/drush) | 5.3.3+ | D6, D7 | <img src="https://travis-ci.org/drush-ops/drush.png?branch=6.x">
17+
Drush 5 | [5.x](https://travis-ci.org/drush-ops/drush) | 5.2.0+ | D6, D7 | <img src="https://travis-ci.org/drush-ops/drush.png?branch=5.x">
18+
Drush 4 | 4.x | 5.2.0+ | D5, D6, D7 | Unsupported
19+
Drush 3 | 3.x | 5.2.0+ | D5, D6 | Unsupported
20+
21+
Drush comes with a full test suite powered by [PHPUnit](https://github.com/sebastianbergmann/phpunit). Each commit gets tested by the awesome [Travis.ci continuous integration service](https://travis-ci.org/drush-ops/drush).
22+
23+
USAGE
24+
-----------
25+
26+
Drush can be run in your shell by typing "drush" from within any Drupal root directory.
27+
28+
$ drush [options] <command> [argument1] [argument2]
29+
30+
Use the 'help' command to get a list of available options and commands:
31+
32+
$ drush help
33+
34+
For even more documentation, use the 'topic' command:
35+
36+
$ drush topic
37+
38+
Installation instructions can be found below. For a full list of Drush commands
39+
and documentation by version, visit http://www.drush.org.
40+
41+
42+
SUPPORT
43+
-----------
1444

15-
Drush Version | Branch | Compatible Drupal versions | Code Status
16-
------------- | ------ | -------------------------- | -----------
17-
Drush 7 | <a href="https://travis-ci.org/drush-ops/drush">master</a> | D6, D7, D8 | <img src="https://travis-ci.org/drush-ops/drush.png?branch=master">
18-
Drush 6 | <a href="https://travis-ci.org/drush-ops/drush">6.x</a> | D6, D7 | <img src="https://travis-ci.org/drush-ops/drush.png?branch=6.x">
19-
Drush 5 | <a href="https://travis-ci.org/drush-ops/drush">5.x</a> | D6, D7 | <img src="https://travis-ci.org/drush-ops/drush.png?branch=5.x">
20-
Drush 4 | 4.x | D5, D6, D7 | Unsupported
21-
Drush 3 | 3.x | D5, D6 | Unsupported
45+
Please take a moment to review the rest of the information in this file before
46+
pursuing one of the support options below.
2247

23-
Drush comes with a full test suite powered by [PHPUnit](https://github.com/sebastianbergmann/phpunit). Each commit gets tested by the awesome [Travis.ci continuous integration service](https://travis-ci.org/drush-ops/drush):
48+
* Post support requests to [Drupal Answers](http://drupal.stackexchange.com/questions/tagged/drush).
49+
* Bug reports and feature requests should be reported in the [GitHub Drush Issue Queue](https://github.com/drush-ops/drush/issues).
50+
* Use pull requests (PRs) to contribute to Drush. See [/CONTRIBUTING.md](CONTRIBUTING.md).
51+
* It is still possible to search the old issue queue on Drupal.org for [fixed bugs](https://drupal.org/project/issues/search/drush?status%5B%5D=7&categories%5B%5D=bug), [unmigrated issues](https://drupal.org/project/issues/search/drush?status%5B%5D=5&issue_tags=needs+migration), [unmigrated bugs](https://drupal.org/project/issues/search/drush?status%5B%5D=5&categories%5B%5D=bug&issue_tags=needs+migration), and so on.
2452

2553
MISC
2654
-----------
2755
* [www.drush.org](http://www.drush.org)
2856
* [A list of modules that include Drush integration](http://drupal.org/project/modules?filters=tid%3A4654)
29-
* For more help, please see the [Resources](http://drush.org/resources) and the [Drush FAQ](http://drupal.org/drush-faq). Run the `drush topic` command for even more help.
57+
* For more information, please see the [Resources](http://drush.org/resources) and the [Drush FAQ](http://drupal.org/drush-faq). Run the `drush topic` command for even more help.
3058
* If you are using Debian or Ubuntu, you can alternatively use the Debian packages uploaded in your distribution. You may need to use the backports to get the latest version, if you are running a LTS or "stable" release.
3159
* For advice on using Drush with your ISP, see the <a href="http://drush.org/resources#hosting">hosting section of the Resources page</a> on <a href="http://drush.org">drush.org</a>.
3260

@@ -70,8 +98,8 @@ INSTALL - MANUAL
7098
-----------
7199
1. Place the uncompressed drush.tar.gz, drush.zip, or cloned git repository in a directory that is outside of your web root.
72100
1. Make the 'drush' command executable:
73-
74-
`$ ln -s /path/to/drush/drush /usr/bin/drush`
101+
102+
`$ chmod u+x /path/to/drush/drush`
75103

76104
1. Configure your system to recognize where Drush resides. There are 2 options:
77105
1. Create a symbolic link to the Drush executable in a directory that is already in your PATH, e.g.:
@@ -94,7 +122,7 @@ INSTALL - MANUAL
94122
1. Test that Drush is found by your system:
95123

96124
`$ which drush`
97-
125+
98126
See the POST-INSTALL section for configuration tips.
99127

100128
POST-INSTALL
@@ -121,7 +149,7 @@ POST-INSTALL
121149
Putting this in a .bashrc/.bash_profile/.profile would produce this prompt:
122150

123151
`msonnabaum@hostname ~/repos/drush (master)[@sitename]$`
124-
152+
125153
1. Help the Drush development team by sending anonymized usage statistics. To automatically send usage data, please add the following to a .drushrc.php file:
126154

127155
```php
@@ -273,29 +301,9 @@ information presented in the example.aliases.drushrc.php file, especially when
273301
setting values for 'remote-host' and 'os', as these are very important when
274302
running Drush rsync and Drush sql-sync commands.
275303

276-
USAGE
277-
-----------
278-
279-
Once you have completed the installation steps, Drush can be run in your shell
280-
by typing "drush" from within any Drupal root directory.
281304

282-
$ drush [options] <command> [argument1] [argument2]
283-
284-
Use the 'help' command to get a list of available options and commands:
285-
286-
$ drush help
287-
288-
For even more documentation, use the 'topic' command:
289-
290-
$ drush topic
291-
292-
For a full list of Drush commands and documentation by version, visit
293-
http://www.drush.org.
294-
295-
Many commands support a --pipe option which returns machine readable output.
296-
For example, return a list of enabled modules:
297-
298-
$ drush pm-list --type=module --status=enabled --pipe
305+
OPTIONS
306+
-----------
299307

300308
For multisite installations, use the -l option to target a particular site. If
301309
you are outside the Drupal web root, you might need to use the -r, -l or other

0 commit comments

Comments
 (0)