Metadata-Version: 2.1
Name: metro-notation
Version: 0.5.0
Summary: Rubik's cube algorithm visualizer
Home-page: https://github.com/kitao/metro-notation
Author: Takashi Kitao
Author-email: takashi.kitao@gmail.com
License: MIT
Description: # metro-notation
        
        Visualize the Rubik's cube algorithms in a notation like a train route map that I call **"Metro notation (メトロ記法)"**.
        
        **"Metro notation"** focuses on the direction in which the force of each finger is applied.
        
        ## Installation
        
        ```sh
        pip3 install metro-notation
        ```
        
        or
        
        ```sh
        pip install metro-notation
        ```
        
        ## Usage
        
        ```sh
        metro-notation [filename]
        ```
        
        ## Algorithm notation format
        
        - ``#`` ignores up to the end of the line as a comment
        - ``[name]`` specifies the name of the following algorithm
        - ``@``+``ROBGWYrobgwy`` describes the arrangement of the cube faces
        - ``RMLUDFBw2xy'`` describes the algorithm
        - ``whitespace`` splits the algorithm into triggers
        - ``----`` splits the following algorithms into separate columns
        
        ```
        #
        # PLL algorithms
        #
        
        [Ua Perm]
        @GGGRoRBrBObOwwwwwwwww
        RU'RU RU RU'R'U' R2
        
        [Z Perm]
        @GrGRgRBoBObOwwwwwwwww
        M2'U'M2'U' M'U2' M2'U2'M'
        
        ----
        
        [Ra Perm]
        @OwwwwwwRRBwBwwwwwwwww
        RU'R'U' RURD R'U'RD' R'U2R'
        
        [Gb Perm]
        @OwOwwwBBwwwwwwwwwwwww
        F'U'F R2UwR'U RU'RUw' R2'
        ```
        
        ## Outputs
        
        **PLL Algorithms**
        
        <img src="images/pll-algorithms.png">
        
        **OLL Algorithms**
        
        <img src="images/oll-algorithms1.png">
        <img src="images/oll-algorithms2.png">
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: Multimedia :: Graphics
Description-Content-Type: text/markdown
