Update readme and build_from_source (#458)

* Update readme and build_from_source Signed-off-by: jinhai <[email protected]> * Update build_from_source.md Minor editorial updates * Update README.md --------- Signed-off-by: jinhai <[email protected]> Co-authored-by: writinwaters <[email protected]>
infiniflow · Jan 21, 2024 · 2ecd55d · 2ecd55d
1 parent 616ff6c
commit 2ecd55d
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -17,6 +17,13 @@
 
 Infinity is a cutting-edge AI-native database that provides a wide range of search capabilities for rich data types such as vectors, full-text, and structured data. It provides robust support for various LLM applications, including search, recommenders, question-answering, conversational AI, copilot, content generation, and many more **RAG** (Retrieval-augmented Generation) applications.
 
+- [Key Features](#key-features)
+- [Get Started](#get-started)
+- [Build from Source](#build-from-source)
+- [Roadmap](#roadmap)
+- [Community](#community)
+
+
 ## 🌟 Key Features
 
 Infinity comes with high performance, flexibility, ease-of-use, and many features designed to address the challenges facing the next-generation AI applications:
@@ -46,23 +53,30 @@ Supports a wide range of data types including strings, numerics, vectors, and mo
 
 ### Deploy Infinity database
 
-#### Deploy using binary package on Linux x86_64
+#### Deploy Infinity using Docker on Linux x86_64 and MacOS x86_64
+
+```bash
+docker pull infiniflow/infinity:nightly
+docker run -d --name infinity -v /tmp/infinity/:/tmp/infinity --network=host infiniflow/infinity:nightly
+```
 
-You can download the binary package (deb, rpm, or tgz) for your respective host operating system from https://github.com/infiniflow/infinity/releases. These packages are designed to be compatible with Linux x86_64 hosts that are no older than CentOS 7. They are statically linked, except for glibc. For example:
+#### Deploy Infinity using binary package on Linux x86_64
 
+You can download the binary package (deb, rpm, or tgz) for your respective host operating system from https://github.com/infiniflow/infinity/releases.
+
+Fedora/RHEL/OpenSUSE/CentOS
 ```bash
+# not older than centos 7
 sudo rpm -i infinity-0.1.0-dev-x86_64.rpm
 sudo systemctl start infinity
 ```
 
-#### Deploy using Docker on Linux x86_64 and MacOS x86_64
-
+Ubuntu
 ```bash
-docker pull infiniflow/infinity:nightly
-docker run -d --name infinity -v /tmp/infinity/:/tmp/infinity --network=host infiniflow/infinity:nightly
+sudo dpkg -i infinity-0.1.0-dev-x86_64.deb
+sudo systemctl start infinity
 ```
 
-
 ### Install Infinity's Python client
 
 ```bash

diff --git a/docs/build_from_source.md b/docs/build_from_source.md
@@ -1,5 +1,7 @@
 # Build from Source
 
+Infinity can only be compiled natively on Linux. If your operating system is not Linux, build it using Docker.
+
 - [Build from source on Linux using Docker](#build-from-source-on-linux-using-docker)
 - [Build from source on Ubuntu 22.04](#build-from-source-on-ubuntu-2204)
 - [Build from source on Ubuntu 23.10](#build-from-source-on-ubuntu-2310)