README.md in dbt-1.1.5 vs README.md in dbt-1.2.0
- old
+ new
@@ -1,14 +1,19 @@
DBT
---
-DBT (Dependencies and deBugging Tool) is a tool that looks for `break`,
-`require`, and `provides` commands (and does a *teensy* bit of code analyzing -
-it will detect VERY basic class and module declarations) to make your RubyMotion
-`debugger_cmds` file easy to create, and declaring your file dependencies stupid
-simple.
+DBT (Dependencies and deBugging Tool) is a RubyMotion tool that works for iOS, OSX,
+and Android to detect classes and dependencies. It will declare them in your config
+so you don't have to manually manage them.
+# iOS/OSX Dependency Analysis
+
+DBT will look for `break`, `require`, and `provides` commands (and does a *teensy*
+bit of code analyzing - it will detect VERY basic class and module declarations)
+to make your RubyMotion `debugger_cmds` file easy to create, and declaring your file
+dependencies stupid simple.
+
**CAUTION**: It overwrites the `debugger_cmds` file!
To use, include this gem (`gem 'dbt'`), and add `DBT.analyze(app)` to your
`Rakefile`, after you have added your own files to `app.files`. It looks at
`app.files` and scans those files, so I mean it when I say "after you have added
@@ -100,10 +105,35 @@
# @provides module:Foo::Bar
module Foo ; module Bar
end end
```
+# Android
+
+In Android, dependencies are handled automatically, but you need to declare your
+`Android::App::Activity` classes in your config. Normally, you'd do something like
+this:
+
+```ruby
+app.sub_activities = [
+ "FirstActivity",
+ "SecondActivity",
+ # etc
+]
+```
+
+With DBT, you can now add these declarations to the top of your activities:
+
+```ruby
+# @activity FirstActivity
+class FirstActivity < Android::App::Activity
+ # ...
+end
+```
+
+That's all the functionality we have for Android at the moment, but it's pretty helpful!
+
# Breakpoints
Breakpoints are created using the syntax `#--> break`, with two or more dashes
before the `>`. There must not be any whitespace before or after the `#`.
@@ -124,5 +154,13 @@
If a line number is given to the `break` command, a breakpoint will be added at
*that* line, otherwise it will be added to the line below `break`. It's better
to insert the `#--> break` where you NEED it, rather than hardcode line numbers,
since line numbers are not constant.
+
+# Running Tests
+
+We have two simple test files, so just run them manually.
+
+```sh-session
+$ ruby spec/ios_spec.rb && ruby spec/android_spec.rb
+```