unit_quaternion 0.0.2 → 0.0.3

data/README.md

@@ -5,10 +5,17 @@ class that is designed to be used to represent rotations.
 
 ## Installation
 
-This package is not available through any gem repository (yet).
-Install it using:
+You can install this gem in either of the following ways:
 
+```
+$ sudo gem install unit_quaternion
+```
+
+or
+
+```
 $ sudo rake install
+```
 
 ## Usage
 
@@ -19,6 +26,7 @@ require 'unit_quaternion'
 
 You can perform basic quaternion operations, such as addition and multiplication:
 
+```
 q1 = Quaternion.new(1,2,3,4)
 => (1, Vector[2, 3, 4])
 
@@ -30,42 +38,55 @@ q1 + q2
 
 q1 * q2
 => (-12, Vector[6, 24, 12])
+```
 
 You can use the UnitQuaternion class to represent spatial rotations.
 The following represents a rotation of PI/2 radians about the x-axis:
 
+```
 qx = UnitQuaternion.fromAngleAxis(Math::PI/2, Vector[1, 0, 0])
 => (0.7071067811865476, Vector[0.7071067811865475, 0.0, 0.0])
+```
 
 The following represents a rotation of PI/2 radians about the y-axis:
 
+```
 qy = UnitQuaternion.fromAngleAxis(Math::PI/2, Vector[0, 1, 0])
 => (0.7071067811865476, Vector[0.0, 0.7071067811865475, 0.0])
+```
 
 You can use quaternion multiplication to compose rotations.  If we
 want to find the quaternion describing a rotation about the body-fixed
 x-axis, followed by a rotation about the body-fixed y-axis, we would
 do the following:
 
+```
 q = qx * qy
 => (0.5000000000000001, Vector[0.5, 0.5, 0.4999999999999999])
+```
 
 Notice that this is the same as:
 
+```
 q = UnitQuaternion.fromEuler(Math::PI/2, Math::PI/2, 0, 'xyz')
 => (0.5000000000000001, Vector[0.5, 0.5, 0.4999999999999999])
+```
 
 If we want to find the quaternion describing a rotation the inertial
 x-axis, followed by a rotation about the inertial y-axis, we would do
 the following:
 
+```
 q = qy * qx
 => (0.5000000000000001, Vector[0.5, 0.5, -0.4999999999999999])
+```
 
 Notice that this is the same as:
 
+```
 q = UnitQuaternion.fromEuler(Math::PI/2, Math::PI/2, 0, 'XYZ')
 => (0.5000000000000001, Vector[0.5, 0.5, -0.4999999999999999])
+```
 
 Additionally, you can use the method fromRotationMatrix to set the
 values of the quaternion from an orthonormal 3x3 matrix.  Finally, you
@@ -77,6 +98,7 @@ The transform method takes a vector as an argument and returns the
 result of rotating that vector through the rotation described by the
 quaternion.  For example:
 
+```
 q = UnitQuaternion.fromAngleAxis(Math::PI/2, Vector[0, 0, 1])
 => (0.7071067811865476, Vector[0.0, 0.0, 0.7071067811865475])
 
@@ -85,6 +107,7 @@ v = Vector[1, 0, 0]
 
 q.transform(v)
 => Vector[2.220446049250313e-16, 1.0, 0.0]
+```
 
 gives the result of rotating the vector (1, 0, 0) through PI/2 radians
 about the z-axis.

data/lib/unit_quaternion/version.rb

@@ -1,3 +1,3 @@
 module Quaternion
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/unit_quaternion.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["cory.crean@gmail.com"]
   spec.description   = %q{Provides a general Quaternion class, and UnitQuaternion class to represent rotations}
   spec.summary       = spec.description
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/ccrean/Quaternion_ruby"
   spec.license       = "BSD"
 
   spec.files         = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unit_quaternion
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-02 00:00:00.000000000 Z
+date: 2016-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,7 +95,7 @@ files:
 - tests/tests_Quaternion.rb
 - tests/tests_UnitQuaternion.rb
 - unit_quaternion.gemspec
-homepage: ''
+homepage: https://github.com/ccrean/Quaternion_ruby
 licenses:
 - BSD
 post_install_message: