README.rst: initial import, replace old

Basic overview for ebuild maintainers and normal users
updated to match the rewrite.

Signed-off-by: Ionen Wolkens <ionen@gentoo.org>

2 files changed, 49 insertions, 15 deletions

diff --git a/README b/README
deleted file mode 100644
index c927113..0000000
--- a/README
+++ /dev/null
@@ -1,15 +0,0 @@
-# eselect-wine
-
-eselect-wine finds installed wine versions by looking for folders named `wine-*` in `$PREFIX` that contain a file `bin/wine`.
-Additionally, it relies on the existance of launcher scripts for the various wine executables in `$BINDIR` with the same suffix as the corresponding folder in `$PREFIX`.
-
-Suffixes matching `$VARIANTS` will cause issues.
-
-Wine should be installed with the following arguments passed to `configure`:
-
-    --prefix="${PREFIX}/wine-${suffix}" \
-    --datadir="${PREFIX}/wine-${suffix}" \
-    --mandir="${PREFIX}/wine-${suffix}/man"
-
-## "Dry" testing
-For the most basic usage, the directory ${PREFIX}/wine-XXX and the files ${PREFIX}/wine-XXX and ${BINDIR}/wine-XXX must exist.
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..ef069d2
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,49 @@
+eselect-wine
+============
+
+Manage active Wine slots and variants.
+
+Example::
+
+    $ eselect wine list
+    Available Wine slots:
+      [1]   wine-proton-7.0.4 *
+
+      [2]   wine-staging-7.19
+      [3]   wine-staging-7.20 * (main)
+      [4]   wine-staging-7.21
+
+      [5]   wine-vanilla-7.0 *
+      [6]   wine-vanilla-7.21
+
+    $ wine --version
+    wine-7.20 (Staging)
+
+    $ wine-vanilla --version
+    wine-7.0
+
+Makes uses of ``/etc/eselect/wine``, ``PATH``, ``MANPATH``, and
+``XDG_DATA_DIRS``. No files in ``/usr`` are modified by this module
+since version >=2.0.0. *After* migration and unlike older eselect,
+losing data from ``/etc/eselect/wine`` is not harmful (can be
+regenerated anytime with ``eselect wine update``).
+
+Using expects the following install layout (``lib64`` is unsupported)::
+
+    /usr/lib/wine-<variant>-<version>/wine/
+    /usr/lib/wine-<variant>-<version>/bin/* (must have 'wine')
+    /usr/bin/*-<variant>-<version> (wrappers to call the above)
+    /usr/include/wine-<variant>-<version>
+    /usr/share/wine-<variant>-<version>/{applications,man}
+
+In ebuilds, note ``(de)register`` or using ``pkg_prerm`` is deprecated, use::
+
+    IDEPEND=">=app-eselect/eselect-wine-2"
+    pkg_postinst() {
+        eselect wine update --if-unset || die
+    }
+    pkg_postrm() {
+        eselect wine update --if-unset || die
+    }
+
+Any arbitrary ``wine-myvariant`` is supported for custom ebuilds.