Full Project Documentation

The full formatted project documentation file is located in the PDF in the root repo folder. It has all of this documentation and more required for the project.

Dependencies

Project is built on python 3.12.1

• pillow 10.3.0 (docs, PyPi)
• automathon 0.0.15 (GitHub, PyPi)
• Graphviz (optional)

Building/Running

First, clone the repository to the desired folder and navigate to /EECS-510-Final-Project/. After that is complete, follow these next sections to complete setup:

Virtual Environment Setup

Use of a virtual environment is recommended such as venv environment or a Conda environment if installing dependencies is not wanted on the root system. If one does not care about dependencies on their root system, you can skip this section.

Conda

> conda create --name myenv python=3.12.1

> conda activate myenv

Venv

> python -m venv venv

activate venv on Mac/Linux:

> source venv/bin/activate

On Windows:

> venv\Scripts\activate

Installing Dependencies

To install dependencies, you can run one of the following commands depending on your Python setup:

Conda

> conda install pillow automathon

venv

> pip install pillow automathon

Running

To run our program, execute the following command:

> python src/main.py

You will then be prompted to enter an input string. Enter a string and hit enter. You should see the acceptance result, a path/trace (if accepted), and a formatted recipe (if accepted).

Alphabet

• A-C : Pastas (Spaghetti, fettuccini, and Macaroni)
• D-F : Sauces (Marina, Alfredo, and Pesto)
• G-J : Addons (Ground meat, Chicken, Olive oil, Garlic, Onions, and Broccoli)