diff options
author | Karl Berry <karl@freefriends.org> | 2018-02-28 23:45:07 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2018-02-28 23:45:07 +0000 |
commit | 940e03ca0b55d204785182f33537a0c75fffbb0e (patch) | |
tree | 14a24a13ec433c2afa013b48b3b5242a82ed41ba /Master/texmf-dist/doc/latex/rubik/README.txt | |
parent | e55c20f6da5b06953c9dde74fa78bf1a277eb237 (diff) |
rubik (28feb18)
git-svn-id: svn://tug.org/texlive/trunk@46764 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/rubik/README.txt')
-rw-r--r-- | Master/texmf-dist/doc/latex/rubik/README.txt | 205 |
1 files changed, 127 insertions, 78 deletions
diff --git a/Master/texmf-dist/doc/latex/rubik/README.txt b/Master/texmf-dist/doc/latex/rubik/README.txt index 1874d1938a3..232a271069b 100644 --- a/Master/texmf-dist/doc/latex/rubik/README.txt +++ b/Master/texmf-dist/doc/latex/rubik/README.txt @@ -1,83 +1,129 @@ - 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) - --------------------------------------------------------------------------- +-------------------------------------------------------- +The RUBIK bundle (version 5) February 24, 2018 + +rubikcube package : macros for typesetting 3x3x3 cubes +rubiktwocube package : macros for typesetting 2x2x2 cubes +rubikrotation package: macros Perl program for rotations +rubikpatterns package: macros for typesetting +-------------------------------------------------------- + +The RUBIK bundle provides four complementary packages for +documenting the Rubik cube (3x3x3) and Twocube (2x2x2) +notation and configurations, and for processing rotation +sequences for both cubes. A Perl program which processes +rotation sequences on the fly is also included. The four +packages are: +(a) the rubikcube (3x3x3) package, +(b) the rubiktwocube (2x2x2) package (NEW), +(c) the rubikrotation package, +(d) the rubikpatterns package. + + + (1) rubikcube package (3x3x3 cubes) + + 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) rubiktwocube package (2x2x2 cubes) NEW + + The rubiktwocube package provides a collection of LaTeX + commands and macros for typesetting TwoCube configurations + and rotation instructions using the PGF/TikZ graphic + languages. + + + (3) rubikrotation package + + The rubikrotation package, is a dynamic extension to the + rubikcube and rubiktwocube packages. 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 Rubik bundle. + + 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 to be run using the --shell-escape + command-line switch (available from the shellesc package). + + + (4) rubikpatterns package + + The RubikPatterns package is a small database of well-known + patterns and sequences in the form of named macros which + can be processed easily using the RubikRotation command. + + + (5) New features + + rubikcube: + --- Improved documentation. + --- Minor improvements to log-file documentation. + --- New commands for drawing cube sidebars adjacent to + cube edges. + --- Two new commands for setting up WY (White opposite + Yellow) and WB (White opposite Blue) `starter grey + cubes'. + --- Bugfix for the \ShowSequence command (fixes a problem + of fonts not being contained appropriately). + --- Added some missing lower case rotation notation. + --- A new \NoSidebar command for disabling sidebars of a + specified colour (mainly for use with OLL displays). + + rubiktwocube: + --- this is new package dealing with 2x2x2 cubes, having + similar functionality to the rubikcube package. + + rubikrotation: + --- minor code improvements in Perl programme, and + improved syntax checking. + --- some minor bugfixes in Perl programme + (eg: a zero or missing integer with random keyword + now generates an error message). + --- added new keyword `cubesize' to hold cube size + ie either `three' or `two' to inform Perl programme + as to which sort of cube is being processed. + + rubikpatterns: + --- (no change from v4). + + +------------------------------------------------------- RWD Nickalls email: dick@nickalls.org A Syropoulos email: asyropoulos@yahoo.com --------------------------------------------------------------------------- -Copyright 2017 RWD Nickalls & A Syropoulos +------------------------------------------------------- + +Copyright 2018 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. --------------------------------------------------------------------------- +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: +Package files: - rubikcube.ins, - rubikcube.dtx, - rubikcube.sty, + - rubiktwocube.ins, + - rubiktwocube.dtx, + - rubiktwocube.sty, - rubikrotation.ins, - rubikrotation.dtx, - rubikrotation.sty, @@ -85,8 +131,9 @@ package files: - rubikpatterns.ins - rubikpatterns.dtx - rubikpatterns.sty -documentation and README: +Documentation and README: - rubikcube.pdf + - rubiktwocube.pdf - rubikrotation.pdf, - rubikrotationPL.pdf (Perl script documentation) - rubikrotationPL.tex @@ -95,16 +142,18 @@ documentation and README: - 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: +Examples: - rubikexamples.pdf, - rubikexamples.tex -bash and bat files (for running rubikexamples.tex and rubikpatternsLIST.tex) --------------------------------------------------------------------------- +Image files: + - pdf files for rubikcube documentation (6 pictures) + - pdf files for rubiktwocube documentation (1 picture) + - pdf files for rubikrotation documentation (4 pictures) + - pdf files for rubikpatterns documentation (1 picture) +Bash and bat files (for processing rubikexamples.tex and + rubikpatternsLIST.tex) +------------------------------------------------------- -If you have any ideas, suggestions, questions, or bugs to report, please -feel free to contact us. --------------------------------------------------------------------------- +If you have any ideas, suggestions, questions, or bugs +to report, please contact us. +------------------------------------------------------- |