Merge pull request #2 from utilityai/update-readme-2

moved readme and added new ones

Author: MarcusDunn

README.md

@@ -1,21 +1,8 @@
-# llama-cpp-rs-2
+# llama-cpp-rs
 
-A wrapper around the [llama-cpp](https://github.com/ggerganov/llama.cpp/) library for rust.
+This contains two packages used internally at [Utility AI](https://utilityai.ca/):
 
-# Goals
+- llama-cpp-2 
+- llama-cpp-sys-2
 
-- Safe
-- Up to date (llama-cpp-rs is out of date)
-- Abort free (llama.cpp will abort if you violate its invariants. This library will attempt to prevent that by ether
-  ensuring the invariants are upheld statically or by checking them ourselves and returning an error)
-- Performant (no meaningful overhead over using llama-cpp-sys-2)
-- Well documented
-
-# Non-goals
-
-- Idiomatic rust (I will prioritize a more direct translation of the C++ API over a more idiomatic rust API due to
-  maintenance burden)
-
-# Contributing
-
-Contributions are welcome. Please open an issue before starting work on a PR.
+See their respective READMEs for more information.

llama-cpp-2/README.md

@@ -0,0 +1,21 @@
+# llama-cpp-rs-2
+
+A wrapper around the [llama-cpp](https://github.com/ggerganov/llama.cpp/) library for rust.
+
+# Goals
+
+- Safe
+- Up to date (llama-cpp-rs is out of date)
+- Abort free (llama.cpp will abort if you violate its invariants. This library will attempt to prevent that by ether
+  ensuring the invariants are upheld statically or by checking them ourselves and returning an error)
+- Performant (no meaningful overhead over using llama-cpp-sys-2)
+- Well documented
+
+# Non-goals
+
+- Idiomatic rust (I will prioritize a more direct translation of the C++ API over a more idiomatic rust API due to
+  maintenance burden)
+
+# Contributing
+
+Contributions are welcome. Please open an issue before starting work on a PR.

llama-cpp-sys-2/README.md

@@ -0,0 +1,3 @@
+# llama-cpp-sys
+
+Raw bindings to llama.cpp with cublas support.