DEVELOPER_DOCS.rdoc in tracksperanto-2.9.4 vs DEVELOPER_DOCS.rdoc in tracksperanto-2.9.5
- old
+ new
@@ -12,11 +12,11 @@
Tracksperanto is currently being developed on Ruby 1.9.3 but it should also work fine on 1.8.7. What you will need is everything mentioned
in the Gemfile plus Bundler. Please develop against the git repo checkout since we no longer package the test fixtures with the gem.
* Checkout the repo at http://github.com/guerilla-di/tracksperanto
-* Run `bundle install' and 'rake' to run the tests
+* Run `bundle install' and `bundle exec rake' to run the tests
* Carry your development, in your own branch or feature branch
* File a pull request or send a patch to info at guerilla-di.org
=== Importing your own formats
@@ -46,16 +46,10 @@
=== Reporting status from long-running operations
Almost every module in Tracksperanto has a method called report_progress. This method is used to notify an external callback of what you are doing, and helps keep
the software user-friendly. A well-behaved Tracksperanto module should manage it's progress reports properly.
-=== Reusing components
-
-Tracksperanto contains some nice bits, such as a full grammar lexer for Shake scripts (Tracksperanto::ShakeGrammar::Lexer), a couple of handy buffering
-classes (Tracksperanto::BufferIO and Tracksperanto::Accumulator) and a parser for any Flame setups containing channels (Tracksperanto::Import::FlameStabilizer).
-Play responsibly.
-
=== Sample script
require "rubygems"
require "tracksperanto"
@@ -71,10 +65,10 @@
some_importer.height = 576
some_importer.io = File.open("source_file.fmt")
# The importer responds to each() so if your file is not too big you can just load all the trackers
# as an array. If you expect to have alot of trackers investigate a way to buffer them on disk
- # instead (see Accumulator)
+ # instead (see Obuf)
trackers = some_importer.to_a
# Create the exporter and pass the output file to it
destination_file = File.open("exported_file.other", "wb")
some_exporter = Tracksperanto.get_exporter("flamestabilizer").new(destination_file)
\ No newline at end of file