From 11b509391efcd4736bd36b0c6344851fc8d8a9b0 Mon Sep 17 00:00:00 2001
From: eroen <eroen@occam.eroen.eu>
Date: Fri, 23 Jan 2015 03:37:16 +0100
Subject: README - implementation notes

---
 README | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/README b/README
index 70cff9d..c927113 100644
--- a/README
+++ b/README
@@ -1,2 +1,15 @@
-## Testing
+# 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.
-- 
cgit v1.2.3-65-gdbad