README.md in collada-0.0.1 vs README.md in collada-0.2.0

- old
+ new

@@ -1,9 +1,11 @@ # Collada This library provides support for loading and processing data from Collada Digital Asset Exchange files. These files are typically used for sharing geometry and scenes. +[![Build Status](https://secure.travis-ci.org/ioquatix/collada.png)](http://travis-ci.org/ioquatix/collada) + ## Installation Add this line to your application's Gemfile: gem 'collada' @@ -16,18 +18,68 @@ $ gem install collada ## Usage -The main loader is incomplete can can only load geometry data at this point in time. +This library is designed to be used in scripts which extract data from collada files and output in some other format. As such, you'd typically create your own conversion script which takes the collada file as an argument. Then, use this library to extract relevant geometry and write it out. +To assist with some basic tasks, the `collada-convert` executable provides a number of basic conversion functions. At present, `collada-convert` is primarily designed to produce [tagged format text][1]. + +[1]: https://github.com/ioquatix/tagged-format + +### Example Conversion + +Several example `.dae` files are included and used as part of the unit tests. The `collada-convert` executable can dump the geometries contained within easily: + + $ ./bin/collada-convert tagged-format -v p3n3 ./test/sample.dae + Cube-mesh: mesh triangles + indices: array index16 + 0 1 2 3 4 5 6 7 8 9 10 11 + 12 13 14 15 16 17 18 19 20 21 22 23 + end + vertices: array vertex-p3n3 + 1.0 1.0 -1.0 0.0 0.0 -1.0 + 1.0 -1.0 -1.0 0.0 0.0 -1.0 + -1.0 -1.0 -1.0 0.0 0.0 -1.0 + -1.0 1.0 -1.0 0.0 0.0 -1.0 + 1.0 1.0 1.0 0.0 0.0 1.0 + -1.0 1.0 1.0 0.0 0.0 1.0 + -1.0 -1.0 1.0 0.0 0.0 1.0 + 1.0 -1.0 1.0 0.0 0.0 1.0 + 1.0 1.0 -1.0 1.0 -0.0 0.0 + 1.0 1.0 1.0 1.0 -0.0 0.0 + 1.0 -1.0 1.0 1.0 -0.0 0.0 + 1.0 -1.0 -1.0 1.0 -0.0 0.0 + 1.0 -1.0 -1.0 -0.0 -1.0 0.0 + 1.0 -1.0 1.0 -0.0 -1.0 0.0 + -1.0 -1.0 1.0 -0.0 -1.0 0.0 + -1.0 -1.0 -1.0 -0.0 -1.0 0.0 + -1.0 -1.0 -1.0 -1.0 0.0 0.0 + -1.0 -1.0 1.0 -1.0 0.0 0.0 + -1.0 1.0 1.0 -1.0 0.0 0.0 + -1.0 1.0 -1.0 -1.0 0.0 0.0 + 1.0 1.0 1.0 0.0 1.0 0.0 + 1.0 1.0 -1.0 0.0 1.0 0.0 + -1.0 1.0 -1.0 0.0 1.0 0.0 + -1.0 1.0 1.0 0.0 1.0 0.0 + end + end + top: offset-table + Cube: $Cube-mesh + end + ## Contributing 1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Add some feature'`) 4. Push to the branch (`git push origin my-new-feature`) 5. Create new Pull Request + +### Desired Features + +* Converter: Support .obj files. +* Support more of the collada standard. ## License Released under the MIT license. \ No newline at end of file