From 15311c3a134fae486a965e17730a6132b20361de Mon Sep 17 00:00:00 2001
From: Angel-HF <49835792+Pelochus@users.noreply.github.com>
Date: Wed, 3 Apr 2024 20:15:06 +0200
Subject: [PATCH] Initial README

---
 README.md | 31 ++++++++++++++++++++++++++++++-
 1 file changed, 30 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 36298e2..1bb9ad1 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,32 @@
+# ezrknn-toolkit2
+This repo tries to make RKNN LLM usage easier
+
+## Requirements
+Keep in mind this repo is focused for:
+- High-end Rockchip SoCs, mainly the RK3588
+- Linux, not Android
+- Linux kernels from Rockchip (as of writing 5.10 and 6.1 from Rockchip should work, if your board has one of these it will very likely be Rockchip's kernel)
+
+## Quick Install
+Run:
+
+```bash
+# TODO
+```
+
+## Test
+Run (cd is required):
+
+```bash
+# TODO
+```
+
+# Original README starts below
+
+<hr>
+<hr>
+<hr>
+
 # Description
   RKLLM software stack can help users to quickly deploy AI models to Rockchip chips. The overall framework is as follows:
     <center class="half">
@@ -36,4 +65,4 @@ Please ensure to download a version of the [Phi2](https://hf-mirror.com/microsof
  - Supports the conversion and deployment of LLM models on RK3588/RK3576 platforms
  - Compatible with Hugging Face model architectures
  - Currently supports the models LLaMA, Qwen, Qwen2, and Phi-2
- - Supports quantization with w8a8 and w4a16 precision
\ No newline at end of file
+ - Supports quantization with w8a8 and w4a16 precision