From f76105eecb48f4d7785187245730a9099e28f74a Mon Sep 17 00:00:00 2001
From: James Ravenscroft <ravenscroftj@gmail.com>
Date: Sun, 9 Apr 2023 17:54:19 +0100
Subject: [PATCH] add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f657200
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# TurboPilot
+
+TurboPilot is a super fast [fauxpilot](https://github.com/fauxpilot/fauxpilot) clone which uses the library behind [llama.cpp](https://github.com/comex/llama.cpp) to run huge [6 Billion Parameter Salesforce Codegen models](https://github.com/salesforce/CodeGen) in 2GiB of RAM.
+
+## Getting Started
+
+```bash
+git clone https://github.com/ravenscroftj/turbopilot
+git submodule init
+cd ggml
+mkdir build
+cd build
+cmake ..
+make codegen
+```
+
+## Getting The Models
+
+Start by downloading either the [2B](https://huggingface.co/moyix/codegen-2B-multi-gptj) or [6B](https://huggingface.co/moyix/codegen-6B-multi-gptj) GPT-J versions of CodeGen.
+
+## Convert The Model
+
+```bash
+python convert-codegen-to-ggml.py ./codegen-6B-multi-gptj 0
+```
+
+## Build GGML
\ No newline at end of file