Skip to content

Update project structure: add setup.py, enhance README with installat… #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update project structure: add setup.py, enhance README with installat… #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
*/__pycache__
result
turing.egg-info
build
dist
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 0 additions & 8 deletions pyproject.toml
View file
Open in desktop
Copy link
Owner

@IllustratedMan-code IllustratedMan-code Oct 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the pull request. I'm a little confused why you deleted pyproject.toml though as that is the modern way to package python projects, see: https://packaging.python.org/en/latest/guides/modernize-setup-py-project/

This file was deleted.

7 changes: 7 additions & 0 deletions setup.py
View file
Open in desktop
Copy link
Owner

@IllustratedMan-code IllustratedMan-code Oct 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why change the version schema here?

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
from setuptools import setup, find_packages

setup(
name="turing-machine",
version="0.1.0",
packages=find_packages(),
)