WIP docs

1 files changed, 18 insertions, 0 deletions

diff --git a/readme.rst b/readme.rst
new file mode 100644
index 0000000..98fe56b
--- /dev/null
+++ b/readme.rst
@@ -0,0 +1,18 @@
+::
+
+  ┏━━━━━━━━━━━━━━━━━━┓
+  ┃ original sources ┠─┐
+  ┗━┯━━━━━━━━━━━━━━━━┛ │
+    └──────────────────┘
+       ┏━━━━━━━━━━━━━┓           ╔═════════════════╗         ┏━━━━━━━━━━━━━━━┓
+       ┃ new sources ┠─┐         ║                 ║         ┃ clean patches ┠─┐
+       ┗━┯━━━━━━━━━━━┛ │  ━━━━🭬  ║    PATCHTREE    ║  ━━━━🭬  ┗━┯━━━━━━━━━━━━━┛ ├─┐
+         └─────────────┘         ║                 ║           └─┬─────────────┘ │
+  ┏━━━━━━━━━━━━━━━━━━┓           ╚═════════════════╝             └───────────────┘
+  ┃ semantic patches ┠─┐
+  ┗━┯━━━━━━━━━━━━━━━━┛ │
+    └──────────────────┘
+
+Patchtree is a tool for generating clean patches for external source trees.
+It allows both patch sources to be maintained separately from the sources they apply to, and templating or scripting of the patches themselves in order to be adjust to variations in the external source tree.
+This makes it a useful for automating the process of backporting bugfixes or adding functionality to existing software releases.