README.md in glitch3d-0.2.2.5 vs README.md in glitch3d-0.2.2.6
- old
+ new
@@ -28,14 +28,17 @@
## Usage
- `glitch3d file.obj`
+will
Options:
-- `mode` : (localized|default|none)
-- `shots-number` : integer representing the number of - images desired
-- `quality` : (high|low)
+- `mode` : (localized|default|none) => glitching strategy
+- `shots-number` : integer representing the number of - images desired (with animate: false)
+- `quality` : (high: 2000 x 2000|low 200 x 200) default: low => size of the render
+- `animate` : (true) default: false => Render .avi file
+- `frame_numbers` : (default: 200) => number of frames
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -46,9 +49,9 @@
Bug reports and pull requests are welcome on GitHub at https://github.com/pskl/glitch3d. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
-## TODO
-- write specs
+Copyright © 217 PSKL <hello@pascal.cc>
+This work is free. You can redistribute it and/or modify it under the
+terms of the Do What The Fuck You Want To Public License, Version 2,
+as published by Sam Hocevar. See the COPYING file for more details.