DEVELOPER_DOCS.rdoc in tracksperanto-2.8.1 vs DEVELOPER_DOCS.rdoc in tracksperanto-2.8.2
- old
+ new
@@ -1,7 +1,15 @@
-== Extending Tracksperanto
+== Hacking Tracksperanto
+=== Tests
+
+Tracksperanto is heavily tested. Please use the Github checkout to also receive some 17+ megabytes of test files that the test suite
+can chew on. If you implement fixes or new features having tests for them is NOT OPTIONAL. We are not in crunchtime shot delivery mode
+here but we are sharing an essential pipeline tool that has to be robust day in day out, year to year. Mmmkay?
+
+So please do not underestimate tests.
+
=== Importing your own formats
You can easily write a Tracksperanto import module - refer to Tracksperanto::Import::Base
docs. Your importer will be configured with width and height of the comp that it is importing, and will get an IO
object with the file that you are processing. You should then yield parsed trackers within the each method (tracker objects should
@@ -71,11 +79,11 @@
# Now when we send export commands to the Slipper it will play them through
# to the Scaler and the Scaler in turn will send commands to the exporter.
slipper.start_export(1024, 576)
trackers.each do | t |
- slipper.start_tracker_segment(t.name)
- t.each {|kf slipper.export_point(kf.frame, kf.abs_x, kf.abs_y, kf.residual) }
- slipper.end_tracker_segment
+ slipper.start_tracker_segment(t.name)
+ t.each {|kf slipper.export_point(kf.frame, kf.abs_x, kf.abs_y, kf.residual) }
+ slipper.end_tracker_segment
end
# And we are done!
\ No newline at end of file