rubiks_cube 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d340c4d6ed10a679b877d834c2051ab5875ce201
-  data.tar.gz: 13e7c52e530391568ef6fc82e6e3ae30f1834788
+  metadata.gz: 780df255a389a0ab949a87416339f0edd8cac095
+  data.tar.gz: fcabdd29db883d17ddce6a78d6d0dd4457bd55c5
 SHA512:
-  metadata.gz: 6d04641548416231a627d4fff3d91e8a79701deeaa586b2d71fa33ff608c7b6154e53e82765f4cd8b0f390a50a89023fa7d45e50c7e17d87e7767a51b772692c
-  data.tar.gz: 4b167f837facba5d44b9158e7d8eedc65a68729f26d813538b6615f809e4bb744fd9b9c5901be8f98311500cbcb9c44c3cedb6b2273b34e951af70374cca2f76
+  metadata.gz: a95dfabd9bba259656258734b382e7b2250b4968b8ebff7c7a58bd16289bc0a35ed766a5dc8163ec37bbb06f849168d48a85085e94b454624dcd39aca81a9e93
+  data.tar.gz: 98330d9d23ebcece0023d2e204862876efb3357f7f5aa1e77b4ddb778391e8faa3204a1ca09f39be28da38d4c73f9c55772e020466dd32f0fa65a065b585d557

data/CONTRIBUTING.md

@@ -11,3 +11,12 @@ Want to contribute? Awesome! Thank you so much.
 5. Push to the branch (`git push origin my-new-feature`)
 6. Create new [Pull
    Request](https://help.github.com/articles/using-pull-requests)
+
+## Running The Tests
+
+```bash
+$ git clone https://github.com/chrishunt/rubiks-cube.git
+$ cd rubiks-cube
+$ bundle install
+$ bundle exec rake
+```

data/README.md

@@ -1,16 +1,39 @@
 # Rubik's Cube
 
+Solve your Rubik's Cube with an **easy** two-cycle solution
+
+## Description
+
 Can you solve the Rubik's Cube? Do you want to learn how? GREAT!
 
 We will teach you a very simple two-cycle solution for solving the Rubik's
 Cube. It's so simple that I used this exact solution to solve the cube
 blindfolded in the [2005 Rubik's World
-Championship](http://worldcubeassociation.org/results/p.php?i=2005HUNT01)
-with a time of 5 minutes and 40 seconds.
-
-With practice, you can easily average less than 3 minutes using this solution
-and will have enough understanding to progress to the [Fridrich CFOP](http://en.wikipedia.org/wiki/Fridrich_Method) method - taking you to 15 second solve times.
-WOW!
+Championship](http://worldcubeassociation.org/results/p.php?i=2005HUNT01) with
+a time of 5 minutes and 40 seconds. After you've mastered this solution, you
+will average less than 3 minutes and will have enough understanding to progress
+to the [Fridrich CFOP](http://en.wikipedia.org/wiki/Fridrich_Method) method -
+making it possible for 15 second solve times. WOW!
+
+## Sections
+
+  1. [Usage](#usage)
+  1. [Setting Rubik's Cube State](#setting-rubiks-cube-state)
+     - [Examples](#examples)
+       - [Solved Cube](#solved-cube)
+       - [Slightly Scrambled Cube](#slightly-scrambled-cube)
+       - [Fully Scrambled Cube](#fully-scrambled-cube)
+  1. [Turning a Rubik's Cube](#turning-a-rubiks-cube)
+  1. [Solving a Rubik's Cube](#solving-a-rubiks-cube)
+     - [Two Cycle Solution](#two-cycle-solution)
+       -  [How It Works: Permutation](#how-it-works-permutation)
+       -  [How It Works: Orientation](#how-it-works-orientation)
+  1. [Algorithms](#algorithms)
+     - [Algorithm Notation](#algorithm-notation)
+       - [M Slice](#m-slice)
+  1. [Installation](#installation)
+  1. [Contributing](#contributing)
+  1. [License](#license)
 
 ## Usage
 
@@ -45,11 +68,11 @@ puts solution.pretty
   # ...
 ```
 
-## Setting Rubik's Cube State Manually
+## Setting Rubik's Cube State
 
-If we'd like to start the Rubik's Cube in a different state, we can do that.
-Most people will want to do this if they have a cube sitting on their desk that
-is already scrambled.
+If you have a scrambled Rubik's Cube sitting in front of you right now, you
+may not know how to get it back to the solved position. That's OK! We can set
+the Rubik's Cube state manually and learn how to solve it.
 
 Describing a cube state may seem complicated at first, but it quickly becomes
 easy after you've done it a few times.
@@ -74,15 +97,15 @@ to help you out.
 
 ![](https://raw.github.com/chrishunt/rubiks-cube/master/img/cube_solved.jpg)
 
-A Rubik's Cube is solved by default, but let's take a look at entering the
-state of a solved cube manually so it makes sense.
+A Rubik's Cube is solved by default.
 
 ```ruby
 require 'rubiks_cube'
 
-cube = RubiksCube::Cube.new(
-  "UF UR UB UL FL FR BR BL DF DR DB DL UFL URF UBR ULB DLF DFR DRB DBL"
-)
+cube = RubiksCube::Cube.new
+
+cube.state
+  #=> "UF UR UB UL FL FR BR BL DF DR DB DL UFL URF UBR ULB DLF DFR DRB DBL"
 
 cube.solved? #=> true
 ```
@@ -91,7 +114,8 @@ cube.solved? #=> true
 
 ![](https://raw.github.com/chrishunt/rubiks-cube/master/img/cube_scramble_1.jpg)
 
-Now let's look at a slightly scrambled cube.
+Notice our cube is now slightly scrambled. We can start our Rubik's Cube in
+this state if we like:
 
 ```ruby
 require 'rubiks_cube'
@@ -107,8 +131,10 @@ cube.solved? #=> false
 
 ![](https://raw.github.com/chrishunt/rubiks-cube/master/img/cube_scramble_2.jpg)
 
-Finally, let's look at a pretty messed up cube. Here's the scramble if you'd
-like to try this one at home:
+And here's a fully scrambled cube. This looks hard to solve. We can start our
+cube in this state if we like and have the solver tell us a solution.
+
+Here's the scramble we used to mix the cube if you'd like to try it yourself:
 
 ```
 U D B2 U B D2 B2 F' R' U2 F U' L2 F L2 B2 L2 R' U R' U' D R2 F2 B2
@@ -126,9 +152,10 @@ cube.solved? #=> false
 
 ## Turning a Rubik's Cube
 
-Each Rubik's Cube face (l, r, f, b, d, u) can be turned clockwise manually by
-calling the appropriate method on the cube. For example, if we'd like to turn
-the right face twice, the down face once, and the back face three times:
+Each Rubik's Cube face ( **L**, **R**, **F**, **B**, **D**, **U** ) can be
+turned clockwise manually by calling the appropriate method on the cube. For
+example, if we'd like to turn the right face twice, the down face once, and the
+back face three times:
 
 ```ruby
 require 'rubiks_cube'
@@ -169,10 +196,10 @@ cube.state
 
 ## Solving a Rubik's Cube
 
-We currently only have a very simple two-cycle solution implemented. This
-solution is very inefficient, but wonderful for humans. Using the two-cycle
-solution, you can quickly learn how to solve the Rubik's Cube without using the
-computer.
+We've provided a simple two-cycle solution to help you solve the Rubik's Cube.
+This solution is very inefficient, but wonderful for humans. Using the
+two-cycle solution, you can quickly learn how to solve the Rubik's Cube without
+using the computer.
 
 ### Two Cycle Solution
 
@@ -224,7 +251,8 @@ setup move.
 
 ## Algorithms
 
-All algorithms can be found in [`RubiksCube::Algorithms`](https://github.com/chrishunt/rubiks-cube/blob/master/lib/rubiks_cube/algorithms.rb)
+All algorithms can be found in
+[`RubiksCube::Algorithms`](https://github.com/chrishunt/rubiks-cube/blob/master/lib/rubiks_cube/algorithms.rb)
 
 ### Algorithm Notation
 

data/lib/rubiks_cube/version.rb

@@ -1,3 +1,3 @@
 module RubiksCube
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/rubiks_cube.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = RubiksCube::VERSION
   spec.authors       = ['Chris Hunt']
   spec.email         = ['c@chrishunt.co']
-  spec.description   = %q{Learn how to solve the Rubik's Cube. It's easy!}
-  spec.summary       = %q{Learn how to solve the Rubik's Cube. It's easy!}
+  spec.description   = %q{Solve your Rubik's Cube with a two-cycle solution}
+  spec.summary       = %q{Solve your Rubik's Cube with a two-cycle solution}
   spec.homepage      = 'https://github.com/chrishunt/rubiks-cube'
   spec.license       = 'MIT'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubiks_cube
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Chris Hunt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-17 00:00:00.000000000 Z
+date: 2013-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,7 +66,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Learn how to solve the Rubik's Cube. It's easy!
+description: Solve your Rubik's Cube with a two-cycle solution
 email:
 - c@chrishunt.co
 executables: []
@@ -123,7 +123,7 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: Learn how to solve the Rubik's Cube. It's easy!
+summary: Solve your Rubik's Cube with a two-cycle solution
 test_files:
 - spec/rubiks_cube/algorithms_spec.rb
 - spec/rubiks_cube/cube_spec.rb