From 1edd2d5c21b71d17d18e110a148ecdf27856c40c Mon Sep 17 00:00:00 2001
From: Frederik Hennig <frederik.hennig@fau.de>
Date: Tue, 23 Jul 2024 13:38:10 +0200
Subject: [PATCH] Mark: v2.0-dev development branch
---
README.md | 34 ++++++++++++++++++++++++++++++++++
docs/source/index.rst | 12 ++++++------
2 files changed, 40 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index b810c2e9b..234075297 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,37 @@
+# pystencils 2.0 Development Branch
+
+You are currently viewing the development branch `v2.0-dev` for *pystencils 2.0*.
+This version marks a complete redesign of pystencil's internal structure.
+The type system, code generators, and just-in-time-compilers are being completely rebuilt here.
+
+## Early Adoption
+
+The development version of pystencils is now ready for early adoption by users.
+Install the current pre-release version either directly through pip:
+
+```
+pip install "git+https://i10git.cs.fau.de/pycodegen/pystencils.git@v2.0-dev"
+```
+
+Or clone the repository locally and do an editable install:
+```
+git clone -b v2.0-dev https://i10git.cs.fau.de/pycodegen/pystencils.git
+pip install -e pystencils
+```
+
+## Documentation
+
+Documentation for this development branch is currently served separately at
+[https://da15siwa.pages.i10git.cs.fau.de/dev-docs/pystencils-nbackend/](https://da15siwa.pages.i10git.cs.fau.de/dev-docs/pystencils-nbackend/)
+
+## Contributing
+
+To contribute patches to *pystencils 2.0*, fork the repository as described in [CONTRIBUTING](CONTRIBUTING.md)
+and branch off from the `v2.0-dev` branch.
+Once you're finished coding, create a merge request onto that same branch and wait for it to be reviewed.
+
+
+
pystencils
==========
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 10a80535d..c1beb0546 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -1,11 +1,11 @@
-pystencils Development Branch Documentation
-===========================================
+pystencils v2.0-dev Documentation
+=================================
-These are the documentation pages for the development branch
-`backend-rework <https://i10git.cs.fau.de/pycodegen/pystencils/-/tree/backend-rework?ref_type=heads/>`_,
-which hosts the rework of pystencils' code generation backend.
-This is an ongoing project; as such, the documentation, too, is still under construction and bound to change rapidly.
+You are currently viewing the documentation pages for the development revision |release|
+of pystencils 2.0.
+These pages have been generated from the branch
+`v2.0-dev <https://i10git.cs.fau.de/pycodegen/pystencils/-/tree/v2.0-dev/>`_.
.. toctree::
:maxdepth: 1
--
GitLab