From 949c92d7dfe65515e7e83318199865ff8d20f8fb Mon Sep 17 00:00:00 2001
From: oobabooga <112222186+oobabooga@users.noreply.github.com>
Date: Thu, 10 Aug 2023 14:32:40 -0300
Subject: [PATCH] Create README.md

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1d4680e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# One-click installers
+
+These are automated installers for [oobabooga/text-generation-webui](https://github.com/oobabooga/text-generation-webui).
+
+The idea is to allow people to use the program without having to type commands in the terminal, thus making it more accessible.
+
+## How it works
+
+The `start` scripts download miniconda, create a conda environment inside the current folder, and then install the webui using that environment.
+
+After the initial installation, the `update` scripts are then used to automatically pull the latest text-generation-webui code and upgrade its requirements.
+
+## Limitations
+
+* The start/update scripts themselves are not automatically updated. To update them, you have to re-download the zips listed on the [main README](https://github.com/oobabooga/text-generation-webui#one-click-installers) and overwrite your existing files.