From de402ccfd0615c8be8540990fae46b5ca1b3ed63 Mon Sep 17 00:00:00 2001
From: Yifan Zhao <yifanz16@illinois.edu>
Date: Wed, 17 Mar 2021 17:38:24 -0500
Subject: [PATCH] Ready to release to testpypi

---
 README.md      | 21 +++++++++++++++------
 pyproject.toml |  6 ++++++
 2 files changed, 21 insertions(+), 6 deletions(-)
 create mode 100644 pyproject.toml

diff --git a/README.md b/README.md
index 2ec57bb..30af705 100644
--- a/README.md
+++ b/README.md
@@ -2,19 +2,28 @@
 
 `predtuner` performs autotuning on program approximation knobs using an error-predictive proxy
 in place of the original program, to greatly speedup autotuning while getting results
-comparable in quality.
-
-Work in progress.
+comparable in quality. `current_version == 0.1`.
 
 ## Requirements
 
-`pip` is needed for installing this package. At the root directory of this repo, do:
+`predtuner` requires `python >= 3.7` and `pip`, preferrably `pip >= 20`.
+To install from PyPI (currently TestPyPI), use
+
+```bash
+python -m pip install -i https://test.pypi.org/simple/ predtuner
+```
+
+### Install from Source
+
+Alternatively, you can install this package from source.
+At the root directory of this repository, do:
 
 ```bash
-pip install -e .
+python -m pip install -e ./
 ```
 
-`-e` can be omitted if you don't intend to modify the code in this package.
+With the flag `-e`, any changes to code in this repo is reflected on the installed version automatically.
+It can be omitted if you don't intend to modify the code in this package.
 
 ## Getting Started
 
diff --git a/pyproject.toml b/pyproject.toml
new file mode 100644
index 0000000..b5a3c46
--- /dev/null
+++ b/pyproject.toml
@@ -0,0 +1,6 @@
+[build-system]
+requires = [
+    "setuptools>=42",
+    "wheel"
+]
+build-backend = "setuptools.build_meta"
\ No newline at end of file
-- 
GitLab