Metadata-Version: 2.1
Name: mazegen
Version: 0.0.2
Summary: Python utility to generate and solve mazes.
Home-page: https://github.com/ujjujjuj/mazegen
Author: Ujjwal Dimri
Author-email: ujjwaldimri123@gmail.com
License: UNKNOWN
Project-URL: Documentation, https://github.com/ujjujjuj/mazegen/README.md
Project-URL: Source, https://github.com/ujjujjuj/mazegen
Description: # Mazegen
        Mazegen is a python command line tool to generate and solve mazes
        
        ## Installation
        ```
        pip install mazegen
        ```
        ## Help
        You can get help information by running `-h` or `--help`
        ```
        mazegen --help
        ```
        This will output the following documentation
        ```
        Usage: mazegen [option] [filename] [optional]
        
        OPTIONS:
        generate        Generates .maze file
        view            Views existing .maze file as an image
        solve           Solves a .maze file
        
        OPTIONAL ARGUMENTS:
        -s, --save      Save generated .png file
        ```
        
        ## Usage
        To generate a pxq maze named `first.maze`, run the following command
        ```
        mazegen generate first.maze
        ```
        To view the output from a .maze file
        ```
        mazegen view first.maze
        ```
        To solve a .maze file
        ```
        mazegen solve first.maze
        ```
        
        ## Options
        * `-s` or `--save` will save the generated image file
        
        ## Example
        An unsolved 42x42 maze<br />
        <img src="https://github.com/ujjujjuj/mazegen/raw/master/example/test.png?raw=true" alt="unsolved" width="270"/><br />
        Solution<br />
        <img src="https://github.com/ujjujjuj/mazegen/raw/master/example/test_sol.png?raw=true" alt="solved" width="270"/><br />
        
        ## Note
        All mazes start from the top left and end at bottom right
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
