Update README and add Makefile

MANIFEST.in

@@ -1,3 +1,4 @@
+include Makefile
 recursive-include src *.pyx *.pxd
 graft tests
 global-exclude *.py[cod] *.c

Makefile

@@ -0,0 +1,15 @@
+.PHONY: build dev clean
+.DEFAULT_GOAL := dev
+
+
+build:
+	pip install -U build
+	python -m build
+
+
+dev:
+	pip install -Ue .
+
+
+clean:
+	git clean -Xfd -e "!/*.code-workspace" -e "!/*.vscode" -e "!/*.idea" -e "!/*.python-version"

README.md

@@ -1,5 +1,19 @@
 # kLoop
 
-kLoop is an implementation of the Python asyncio event loop written in Cython,
+kLoop is an implementation of the Python
-using io_uring and kTLS features of the Linux kernel, open-sourced and released
+[asyncio](https://docs.python.org/3/library/asyncio.html) event loop written
-under the MulanPSL - 2.0 license.
+in [Cython](https://cython.org/), using
+[io_uring](https://unixism.net/loti/what_is_io_uring.html) and
+[kTLS](https://www.kernel.org/doc/html/latest/networking/tls-offload.html)
+features of the Linux kernel, open-sourced and released
+under the [MulanPSL - 2.0 license](http://license.coscl.org.cn/MulanPSL2).
+
+**⚠️WARNING: THIS PROJECT IS IN PROOF-OF-CONCEPT STAGE!⚠️**
+
+
+## Requirements
+
+* Python >= 3.8
+* Linux >= 5.11 (enable ktls with `modprobe ktls`)
+* OpenSSL 1.1.1 (3.0 is unnecessary)
+