Skip to content

Commit cc807e3

Browse files
committed
Convert README to Markdown.
1 parent 1ce4927 commit cc807e3

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed
Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,48 @@
1-
{rdoc-image:https://travis-ci.org/voxiky/abrt-ruby.svg?branch=master}[https://travis-ci.org/voxik/abrt-ruby]
1+
[![Build Status](https://travis-ci.org/voxiky/abrt-ruby.svg?branch=master)](https://travis-ci.org/voxik/abrt-ruby)
22

3-
= abrt
3+
# abrt
44

55
Provides ABRT reporting support for libraries/applications written using Ruby.
66

77
Please note that ABRT will be able to report errors only for applications which are already RPM packaged. Errors in other applications are ignored.
88

9-
== Installation
9+
## Installation
1010

11-
<tt>
11+
```
1212
$ gem install abrt
13-
</tt>
13+
```
1414

1515
or if you're using Bundler, put
1616

17-
<tt>
17+
```
1818
gem "abrt", :require => false
19-
</tt>
19+
```
2020

21-
line into your <em>Gemfile</em>.
21+
line into your *Gemfile*.
2222

23-
== Usage
23+
## Usage
2424

2525
There are several ways how to run any application with ABRT handler enabled.
2626

27-
1. Use <tt>require 'abrt'</tt> at the beginning of your application.
28-
2. If you can't modify the application and you still want to use ABRT support, then you need to define <tt>RUBYOPT="-rabrt"</tt> environment variable. This will ensure that ABRT support gets loaded and the exception handler hooks are installed.
29-
3. If you want to ensure, that ABRT handler is always used, add <tt>RUBYOPT="-rabrt"</tt> into your <em>.bashrc</em> file. This will ensure, that Ruby loads ABRT handler every time its starts.
27+
1. Use `require 'abrt'` at the beginning of your application.
28+
2. If you can't modify the application and you still want to use ABRT support, then you need to define `RUBYOPT="-rabrt"` environment variable. This will ensure that ABRT support gets loaded and the exception handler hooks are installed.
29+
3. If you want to ensure, that ABRT handler is always used, add `RUBYOPT="-rabrt"` into your *.bashrc* file. This will ensure, that Ruby loads ABRT handler every time its starts.
3030
4. In Fedora, since ruby-2.0.0.247-9.fc19, Ruby loads abrt gem automatically.
3131

3232
Now, everytime the unhandled exception is captured, ABRT handler prepares bugreport, which can be submitted into http://bugzilla.redhat.com component later using standard ABRT tools.
3333

34-
== Contributing to abrt
34+
## Contributing to abrt
3535

36-
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
37-
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
38-
* Fork the project.
39-
* Start a feature/bugfix branch.
40-
* Commit and push until you are happy with your contribution.
41-
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
42-
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
36+
- Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
37+
- Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
38+
- Fork the project.
39+
- Start a feature/bugfix branch.
40+
- Commit and push until you are happy with your contribution.
41+
- Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
42+
- Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
4343

44-
== Copyright
44+
## Copyright
4545

46-
Copyright (c) 2012 Vít Ondruch. See LICENSE.txt for
46+
Copyright (c) 2012-2017 Vít Ondruch. See LICENSE.txt for
4747
further details.
4848

0 commit comments

Comments
 (0)