Extensive documentation

.github/FUNDING.yml

@@ -0,0 +1 @@
+ko_fi: turboderp

LICENSE

@@ -0,0 +1,19 @@
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,44 @@
+<p align="center">
+
+# ExUI
+
+This is a simple, lightweight web interface for [ExLlamaV2](https://github.com/turboderp/exllamav2).
+
+### Overview of features
+
+- Friendly, responsive and minimalistic UI
+- Persistent sessions
+- Multiple instruct formats
+- Speculative decoding
+- Supports EXL2, GPTQ and FP16 models
+
+### Screenshots
+
+[![chat_screenshot](doc/screenshot1_thumb.png)](doc/screenshot1.png)
+[![chat_screenshot](doc/screenshot2_thumb.png)](doc/screenshot2.png)
+
+### Running locally
+
+First, clone this repository and install requirements:
+
+```
+git clone https://github.com/turboderp/exui
+cd exui
+pip install -r requirements.txt
+```
+
+Then run the web server with the included server.py:
+
+```
+python server.py
+```
+
+Your browser should automatically open on `localhost:5000` 
+
+### More to come
+
+Stay tuned.
+
+![avatar_unicorn.png](static%2Fgfx%2Favatar_unicorn.png)
+
+