Skip to content

Commit

Permalink
README.textile -> README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rocky committed Dec 1, 2012
1 parent 86d98d7 commit d2630f2
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 13 deletions.
20 changes: 8 additions & 12 deletions README.textile → README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
A modular, testable debugger for MRI Ruby 1.9.3 or 1.9.2. A total rewrite of _ruby-debug_.
A modular, testable debugger for MRI Ruby 1.9.3 or 1.9.2. A total rewrite of *ruby-debug*.

__In order to use this debugger, you'll need a patched MRI Ruby 1.9.3 or 1.9.2 and some additional packages. See the "installation instructions.":https://github.com/rocky/rb-trepanning/wiki/How-to-Install-rb-trepanning__
**In order to use this debugger, you'll need a patched MRI Ruby 1.9.3 or 1.9.2 and some additional packages.** See the [installation instructions](https://github.com/rocky/rb-trepanning/wiki/How-to-Install-rb-trepanning).

Right now this debugger is beta code.
There is a ["google group mailing list](http://groups.google.com/group/ruby-debugger for Ruby debuggers.)

There is a "google group mailing list":http://groups.google.com/group/ruby-debugger for Ruby debuggers.

If rb-trepanning is installed, here is how to run:
If *trepanning* is installed, here is how to run:

```console
$ trepan ruby-program [program]
Expand All @@ -26,7 +24,7 @@ If you want to run from the source tree you can do that too:
./bin/trepan -- ruby-program [program args...]
```

Running from inside _irb_:
Running from inside *irb*:

```ruby
require 'trepanning'
Expand All @@ -50,9 +48,9 @@ The above is really shorthand for something like:
$trepan.debugger
```

The global variable $trepan set holds debugger settings, such as "autolist" or "autoeval" settings and breakpoint information.
The global variable *$trepan* set holds debugger settings, such as `autolist" or `autoeval` settings and breakpoint information.

Due to the line-event orientation in ruby-debug, it occasionally was convenient to add a synchronous stop in your program. I don't think that will be necessary here, but if you do call to the debugger at the point of the call rather than the subsequent stopping point, set opts[:immediate] to true. Example:
Due to the line-event orientation in ruby-debug, it occasionally was convenient to add a synchronous stop in your program. I don't think that will be necessary here, but if you do call to the debugger at the point of the call rather than the subsequent stopping point, set `opts[:immediate]` to *true*. Example:

```ruby

Expand All @@ -61,6 +59,4 @@ Due to the line-event orientation in ruby-debug, it occasionally was convenient
# ... work, work, work
```

There is extensive on-line help. Run "help" inside the debugger.


There is extensive on-line help. Run `help` inside the debugger.
2 changes: 1 addition & 1 deletion trepanning.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ EOF
spec.platform = Gem::Platform::RUBY
spec.require_path = 'lib'
# spec.required_ruby_version = '~> 1.9.2frame'
spec.summary = 'Modular Ruby 1.9.2 or 1.9.3 Debugger'
spec.summary = 'Modular Ruby 1.9.3 or 1.9.2 Debugger'
spec.version = Trepan::VERSION

# Make the readme file the start page for the generated html
Expand Down

0 comments on commit d2630f2

Please sign in to comment.