Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[build-system]
requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"
5 changes: 2 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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'],
}
)
)