add README

README.md

@@ -0,0 +1,14 @@
+# ogdf-wheel - an OGDF release build packaged as ready-to-use python wheel.
+
+This project uses [cibuildwheel](cibuildwheel.readthedocs.io) to build the [OGDF](github.com/ogdf/ogdf) library into a ready-to-use python package (called wheel) installable via `pip install ogdf-wheel`. Its mainly intended to be used with [`ogdf-python`](github.com/ogdf/ogdf-python) when you don't want to build the OGDF yourself or use a C++ package manager.
+
+## Publishing new Releases
+
+The CI does neither automatically build new OGDF versions nor directly publishes the results to [PyPi](https://pypi.org/project/ogdf-wheel/). To publish a new version, perform the following steps:
+
+- Update the `/ogdf/` submodule in this repo to point to the latest release of the OGDF.
+- Update the version number in `pyproject.toml`.
+- Commit and push your changes to GitHub.
+- Wait for the CI there to finish.
+- Download the resulting `.whl` files.
+- Use [`twine`](https://twine.readthedocs.io/en/stable/index.html) to upload the files to PyPi.

pyproject.toml

@@ -10,7 +10,7 @@ license-files = { paths = [
     "ogdf/LICENSE_GPL_v3.txt",
     "ogdf/include/ogdf/lib/minisat/LICENSE",
 ] }
-# readme = "README.md"
+readme = "README.md"
 # keywords = ["one", "two"]
 # license = { text = "BSD 3-Clause License" }
 # dependencies = ["matplotlib", "annoy ~= 1.17.0"]