diff --git a/README.md b/README.md index e43d4da..173e1f0 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,25 @@ $ unimatrix -n -s 96 -l o ``` ## Install +### Modern Python Installation (Recommended) + +Unimatrix now uses modern Python packaging standards with `pyproject.toml`, allowing for a robust installation via `pip` directly from the source directory. + +1. **Clone the repository:** + ```bash + git clone https://github.com/will8211/unimatrix.git + cd unimatrix + ``` +2. **Install using pip:** + ```bash + pip install . + ``` + +Alternatively, you can install directly from the GitHub repository: +```bash +pip install git+https://github.com/will8211/unimatrix.git +``` + Linux users can use curl to install: ``` sudo curl -L https://raw.githubusercontent.com/will8211/unimatrix/master/unimatrix.py -o /usr/local/bin/unimatrix diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..638dd9c --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["setuptools>=61.0"] +build-backend = "setuptools.build_meta" diff --git a/setup.py b/setup.py index 0b2cdb5..5f254b9 100644 --- a/setup.py +++ b/setup.py @@ -12,10 +12,9 @@ author='William Mannard', description='Python script to simulate the display from "The Matrix" in terminal', long_description=readme, - use_scm_version=True, - setup_requires=['setuptools_scm'], + version='0.1.0', py_modules=['unimatrix'], entry_points={ 'console_scripts': ['unimatrix=unimatrix:main'], } -) +) \ No newline at end of file