You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Improved the headings in the README. Changed all headings to the same syntax, fixed heading levels and changed to bold where headings were used for emphasis.
Copy file name to clipboardexpand all lines: README.md
+17-25
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,9 @@
1
-
## IMPORTANT: [Ruby 2.1 is officially outdated and unsupported!](https://www.ruby-lang.org/en/news/2016/03/30/ruby-2-1-9-released/) Please upgrade to Ruby >=2.3 or >=2.2.8 before installing Guard!
1
+
#Guard
2
2
3
-
### (To install for older versions, update Bundler at least 1.12: `gem update bundler` and Bundler should correctly resolve to earlier gems for your given Ruby version).
3
+
**IMPORTANT: [Ruby 2.1 is officially outdated and unsupported!](https://www.ruby-lang.org/en/news/2016/03/30/ruby-2-1-9-released/) Please upgrade to Ruby >=2.3 or >=2.2.8 before installing Guard! To install for older versions, update Bundler at least 1.12: `gem update bundler` and Bundler should correctly resolve to earlier gems for your given Ruby version.**
4
4
5
5
:exclamation: Guard is currently accepting more maintainers. Please [read this](https://github.com/guard/guard/wiki/Maintainers) if you're interested in joining the team.
Before you file an issue, make sure you have read the _[known issues](#issues)_ and _[file an issue](#file-an-issue)_ sections that contains some important information.
32
29
33
-
####Features
30
+
## Features
34
31
35
32
* File system changes handled by our awesome [Listen](https://github.com/guard/listen) gem.
36
33
* Support for visual system notifications.
37
34
* Huge eco-system with [more than 220](https://rubygems.org/search?query=guard-) Guard plugins.
38
35
* Tested against Ruby 2.2.8, 2.3.5, 2.4.2, JRuby & Rubinius.
39
36
40
-
####Screencast
37
+
## Screencast
41
38
42
39
Two nice screencasts are available to help you get started:
43
40
44
41
*[Guard](http://railscasts.com/episodes/264-guard) on RailsCast.
45
42
*[Guard is Your Best Friend](http://net.tutsplus.com/tutorials/tools-and-tips/guard-is-your-best-friend) on Net Tuts+.
46
43
47
-
Installation
48
-
------------
44
+
## Installation
49
45
50
46
The simplest way to install Guard is to use [Bundler](http://bundler.io).
**It's important that you always run Guard through Bundler to avoid errors.**
87
83
@@ -105,7 +101,7 @@ If you're getting sick of typing `bundle exec` all the time, try one of the foll
105
101
106
102
* Or, for RubyGems < 2.2.0 check out the [Rubygems Bundler](https://github.com/rvm/rubygems-bundler).
107
103
108
-
####Add Guard plugins
104
+
## Add Guard plugins
109
105
110
106
Guard is now ready to use and you should add some Guard plugins for your specific use. Start exploring the many Guard
111
107
plugins available by browsing the [Guard organization](https://github.com/guard) on GitHub or by searching for `guard-`
@@ -122,8 +118,7 @@ end
122
118
See the init section of the Guard usage below to see how to install the supplied plugin template that you can install and
123
119
to suit your needs.
124
120
125
-
Usage
126
-
-----
121
+
## Usage
127
122
128
123
Guard is run from the command line. Please open your terminal and go to your project work directory.
129
124
@@ -142,35 +137,32 @@ directory for a `.Guardfile`.
142
137
143
138
Please look here to see all the [command line options for Guard](https://github.com/guard/guard/wiki/Command-line-options-for-Guard)
144
139
145
-
Interactions
146
-
------------
140
+
## Interactions
141
+
147
142
Please read how to [interact with Guard](https://github.com/guard/guard/wiki/Interacting-with-Guard) on the console and which [signals](https://github.com/guard/guard/wiki/Interacting-with-Guard#guard-signals) Guard accepts
148
143
149
144
150
-
Guardfile DSL
151
-
-------------
145
+
## Guardfile DSL
146
+
152
147
For details on extending your `Guardfile` look at [Guardfile examples](https://github.com/guard/guard/wiki/Guardfile-examples) or look at a list of commands [Guardfile-DSL / Configuring-Guard](https://github.com/guard/guard/wiki/Guardfile-DSL---Configuring-Guard)
153
148
154
-
Issues
155
-
------
149
+
## Issues
156
150
157
151
Before reporting a problem, please read how to [File an issue](https://github.com/guard/guard/blob/master/CONTRIBUTING.md#file-an-issue).
158
152
159
-
Development / Contributing
160
-
--------------------------
153
+
## Development / Contributing
161
154
162
155
See the [Contributing Guide](https://github.com/guard/guard/blob/master/CONTRIBUTING.md#development).
0 commit comments