From bfea689bb643120c045d0f08662331adb4af6fba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miguel=20Ca=C3=A7ador=20Peixoto?= Date: Mon, 20 Oct 2025 19:15:34 +0100 Subject: [PATCH] Update project structure: add setup.py, enhance README with installation instructions, and update .gitignore --- .gitignore | 3 +++ README.md | 17 +++++++++++++++++ pyproject.toml | 8 -------- setup.py | 7 +++++++ 4 files changed, 27 insertions(+), 8 deletions(-) delete mode 100644 pyproject.toml create mode 100644 setup.py diff --git a/.gitignore b/.gitignore index 0738042..578f397 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,5 @@ */__pycache__ result +turing.egg-info +build +dist \ No newline at end of file diff --git a/README.md b/README.md index fda508f..91c0bd3 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,23 @@ This project is a simple Turing machine that I originally wrote to check my homework. It eventually got a little out of hand, and now it can generate animations and state diagrams as well as test. +# Installation + +## Prerequisites + +Install Graphviz (required for state diagram generation): +```bash +sudo apt update -y && sudo apt install graphviz -y +``` + +## Install + +```bash +git clone https://github.com/IllustratedMan-code/TuringMachine +cd TuringMachine +python setup.py install +``` + # Usage - Begins at left-most symbol of input tape diff --git a/pyproject.toml b/pyproject.toml deleted file mode 100644 index 488b573..0000000 --- a/pyproject.toml +++ /dev/null @@ -1,8 +0,0 @@ -[project] -name = "turing" -version = "1.0.0" -dependencies = [ - "graphviz", - "matplotlib", - "nltk" -] diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..d358612 --- /dev/null +++ b/setup.py @@ -0,0 +1,7 @@ +from setuptools import setup, find_packages + +setup( + name="turing-machine", + version="0.1.0", + packages=find_packages(), +) \ No newline at end of file