diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/rubik/README.txt')
-rw-r--r-- | Master/texmf-dist/doc/latex/rubik/README.txt | 88 |
1 files changed, 50 insertions, 38 deletions
diff --git a/Master/texmf-dist/doc/latex/rubik/README.txt b/Master/texmf-dist/doc/latex/rubik/README.txt index 73e4741a858..1874d1938a3 100644 --- a/Master/texmf-dist/doc/latex/rubik/README.txt +++ b/Master/texmf-dist/doc/latex/rubik/README.txt @@ -1,62 +1,65 @@ -September 25, 2015 + March 3, 2017 -------------------------------------------------------------------------- -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 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 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. +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. - 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. + 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)LaTeX needs - to be run using the --shell-escape command-line switch. + 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 - (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. + 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. - (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. + 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 2014 RWD Nickalls & A Syropoulos +Copyright 2017 RWD Nickalls & A Syropoulos Licence @@ -68,6 +71,7 @@ The latest version of this license is in 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: @@ -77,22 +81,30 @@ package files: - rubikrotation.ins, - rubikrotation.dtx, - rubikrotation.sty, - - rubikrotation.pl (Perl script) + - rubikrotation.pl (Perl script) + - rubikpatterns.ins + - rubikpatterns.dtx + - rubikpatterns.sty documentation and README: - rubikcube.pdf - rubikrotation.pdf, - - rubikrotationPL.pdf, Prel program documentation + - rubikrotationPL.pdf (Perl script documentation) - rubikrotationPL.tex - - rubikrotation.1, MAN file for perl script + - 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: - - example-rot.pdf, - - example-rot.tex -bash and bat files (for running rotation examples) + - rubikexamples.pdf, + - rubikexamples.tex +bash and bat files (for running rubikexamples.tex and rubikpatternsLIST.tex) -------------------------------------------------------------------------- -If you have any ideas, questions, suggestions or bugs to report, please + +If you have any ideas, suggestions, questions, or bugs to report, please feel free to contact us. -------------------------------------------------------------------------- |