
 March 3, 2017
--------------------------------------------------------------------------
 The RUBIK bundle 2017/03/03
 - rubikcube package v4.0      -> macros and commands for typesetting
 - rubikrotation package v4.0  -> macros and Perl program for rotations
 - rubikpatterns package v4.0  -> macros and commands for typesetting
--------------------------------------------------------------------------

The RUBIK bundle provides three complementary packages for documenting the
Rubik cube (3x3x3) notation, configurations and for processing rotation sequences.
The three packages are (a) the rubikcube package, (b) the rubikrotation package,
and (c) the rubikpatterns package.

 (1) Rubikcube package

 The  rubikcube  package   provides  a collection of LaTeX commands 
 and macros for  typesetting  Rubik cube  configurations  and rotation 
 instructions using the  PGF/TikZ graphic languages.
 
 (2) Rubikrotation package

 The rubikrotation package, is a dynamic extension to
 the rubikcube package. It consists of  the  Perl script 
 rubikrotation.pl  and style option rubikrotation.sty.
 The rubikrotation package  implements rotation sequences and 
 random  scrambling of the Rubik cube on-the-fly, using the
 RubikRotation command. It returns the new Rubik state in a form 
 which can then be typeset using commands from the rubikcube package.

 Since the  RubikRotation command works by CALLing the  
 Perl script rubikrotation.pl, it follows that the rubikrotation
 package requires (a) Perl to be installed, and (b) (Pdf/Lua)LaTeX needs
 to  be run using the --shell-escape command-line switch (LuaLaTeX will
 require access to the recent shellesc package). 

 (3) New features

   rubikcube:
   --- Improved documentation.
   --- Additional notation for middle slice rotations (`m' notation).
   --- Additional notation for whole cube rotations (`c' notation).
   --- Added Randelshofer notation  (the `CMST' rotations).
   --- Two new \Draw.. commands which replace earlier (now deprecated 
          but still supported) versions.
   --- Six new commands for showing and annotating rotation sequences. 
   --- A new command for setting up a `solved'  colour configuration.
   --- A new command for setting up a `starter cube' for which the whole
          cube is allocated the default grey colour.  

   rubikrotation:
   --- better syntax checking
   --- 4 new macros SequenceInfo, SequenceName, SequenceShort, SequenceLong
   
   rubikpatterns: 
   --- a new package (a small database of patterns and sequences)

--------------------------------------------------------------------------
RWD Nickalls    email: dick@nickalls.org
A Syropoulos    email: asyropoulos@yahoo.com
--------------------------------------------------------------------------
Copyright 2017 RWD Nickalls & A Syropoulos

Licence

This work may be distributed and/or modified under the
conditions of the LaTeX Project Public License, either version 1.3
of this license or (at your option) any later version.
The latest version of this license is in
  http://www.latex-project.org/lppl.txt
and version 1.3 or later is part of all distributions of LaTeX
version 2005/12/01 or later.
--------------------------------------------------------------------------

The RUBIK bundle consists of the following files

package files:
 - rubikcube.ins,
 - rubikcube.dtx,
 - rubikcube.sty,
 - rubikrotation.ins,
 - rubikrotation.dtx,
 - rubikrotation.sty,
 - rubikrotation.pl    (Perl script)
 - rubikpatterns.ins
 - rubikpatterns.dtx 
 - rubikpatterns.sty
documentation and README:
 - rubikcube.pdf
 - rubikrotation.pdf,
 - rubikrotationPL.pdf (Perl script documentation)
 - rubikrotationPL.tex
 - rubikrotation.1     (MAN file for Perl script)
 - rubikpatterns.pdf
 - rubikpatternsLIST.pdf
 - rubikpatternsLIST.tex
 - README.txt (this file)
image files:
 - pdf -files for the rubikcube documentation (6 pictures)
 - pdf -files for the rubikrotation documentation (4 pictures)
 - pdf -files for the rubikrotation documentation (1 picture)
examples:
 - rubikexamples.pdf,
 - rubikexamples.tex
bash and bat files (for running rubikexamples.tex and rubikpatternsLIST.tex) 
--------------------------------------------------------------------------

If you have any ideas, suggestions, questions, or bugs to report, please
feel free to contact us.
--------------------------------------------------------------------------
