summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/rubik/README.txt
blob: 73e4741a858022e6e2b7b3767deed9f0eb97f86f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

September 25, 2015
--------------------------------------------------------------------------
the RUBIK bundle 2015/09/25
 - rubikcube package v3.0      -> macros and commands for typesetting
 - rubikrotation package v3.0  -> macros and Perl program for rotations
--------------------------------------------------------------------------

The RUBIK bundle provides two complementary packages for documenting the
Rubik cube (3x3x3) notation, configurations and rotation sequences.
The two packages are (a) rubikcube package, and (b) rubikrotation 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.
 This is a stand-alone LaTeX package. However, it is expected to be used in 
 conjunction with its complementary rubikrotation package.

 (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 a
 RubikRotation command. It returns the new state in a form 
 which is then used for typesetting by 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)LaTeX needs
 to  be run using the --shell-escape command-line switch.

 (3) New features

 (a) All rotation commands can now use the rotation-code as an argument; 
     for example, the rotation \rr{D} can now be typeset using the 
     command \cmd{\rr\{D\}} etc.  The new rotation commands are:
        \rr{<rotation-code>}
        \rrh{<rotation-code>}
        \Rubik{<rotation-code>}
        \textRubik{<rotation-code>}
     The original rotation command formats (e.g.,\rrD) are still supported
     for  backwards compatibility.

 (b) \ShowCube and \ShowCubeF  are new commands for displaying
     a cube inside a minipage.

 (c) \RubikCubeGrey is a new command for setting up a `starter cube' 
     for which the only allocated colours are those for the centre cubies
     The colour configuration matches that of the \RubikCubeSolved  command.

--------------------------------------------------------------------------
RWD Nickalls    email: dick@nickalls.org
A Syropoulos    email: asyropoulos@yahoo.com
--------------------------------------------------------------------------
Copyright 2014 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)
documentation and README:
 - rubikcube.pdf
 - rubikrotation.pdf,
 - rubikrotationPL.pdf, Prel program documentation
 - rubikrotationPL.tex
 - rubikrotation.1,   MAN file for perl script
 - README.txt (this file)
image files:
 - pdf -files for the rubikcube documentation (6 pictures)
 - pdf -files for the rubikrotation documentation (4 pictures)
examples:
 - example-rot.pdf,
 - example-rot.tex
bash and bat files (for running rotation examples) 
--------------------------------------------------------------------------
If you have any ideas, questions, suggestions or bugs to report, please
feel free to contact us.
--------------------------------------------------------------------------