From c5aeb6bd9a10e7becf94c5a91f1984487a270747 Mon Sep 17 00:00:00 2001 From: Grigorii Safronov Date: Sat, 7 Sep 2024 08:46:05 +0000 Subject: [PATCH] =?UTF-8?q?=D0=98=D0=B7=D0=BC=D0=B5=D0=BD=D0=B8=D0=BB(?= =?UTF-8?q?=D0=B0)=20=D0=BD=D0=B0=20'README.md'?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 92 +++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 73 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index cd47bf8b..669ebd8b 100644 --- a/README.md +++ b/README.md @@ -10,15 +10,22 @@ ### Table of contents -1. [New version](#version) -2. [Introduction](#introduction) -3. [Install](#Install) -4. [Time travel](#time-travel) -5. [Getting Started](#getting-started) -6. [Links](#links) -7. [Licensing and contributing](#licensing-and-contributing) +1. [About The Project](#about-the-project) +2. [Getting Started](#getting-started) +3. [Gratitudes](#gratitudes) +4. [Requirements](#requirements) + * [Introduction](#introduction) +5. [Building](#building) +6. [Install](#Install) +7. [Time travel](#time-travel) +8. [Getting Started](#getting-started) +9. [Links](#links) +10. [Licensing and contributing](#licensing-and-contributing) + + + +## About The Project -## New version Version v0.7: after HNSW vector search from 0.6, in 0.7 we bring to you MinHash-LSH for near-duplicate search, full-text search, Json value support and more! See [here](https://docs.cozodb.org/en/latest/releases/v0.7.html) for more details. @@ -57,6 +64,64 @@ that uses **Datalog** for query, is **embeddable** but can also handle huge amou and focuses on **graph** data and algorithms. It supports **time travel** and it is **performant**! +## Gratitudes + +* **Philip O' Toole**, I wish to express my appreciation for all your efforts!!! +
+ + + +## Requirements + +* Hardware: Intel or AMD +* Processor: 64-bit +* RAM: 1 GB or higher +* Nodes: 5 (strongly recomended) +* Operating System: UNIX-like only (Linux, BSD(except OpenBSD), MacOS X) **Windows isn't supported** + + + + +### Building + +1. **Install Rust 1.78 or higher build-essential in your operating system** + + +2. Clone the fluidb-repo + + ```sh + git clone https://source.fluidb.icu/fluidB/fluidb + + +3. Change folder + + ```sh + cd fluidb + ``` + +4. Running compilation + ```sh + cargo build + ``` +5. Running server fluidb + ```sh + cd target/debug/fluidb-bin + ``` + + + +## Getting started + +Usually, to learn a database, you need to install it first. +This is unnecessary for CozoDB as a testimony to its extreme embeddability, since you can run +a complete CozoDB instance in your browser, at near-native speed for most operations! + +So open up the [CozoDB in WASM page](https://www.cozodb.org/wasm-demo/), and then: + +* Follow the [tutorial](https://docs.cozodb.org/en/latest/tutorial.html). + +Or you can skip ahead for the information about installing CozoDB into your favourite environment first. + ### What does _embeddable_ mean here? A database is almost surely embedded @@ -138,17 +203,6 @@ On a 2020 Mac Mini with the RocksDB persistent storage engine (CozoDB supports m For more numbers and further details, we have a writeup about performance [here](https://docs.cozodb.org/en/latest/releases/v0.3.html). -## Getting started - -Usually, to learn a database, you need to install it first. -This is unnecessary for CozoDB as a testimony to its extreme embeddability, since you can run -a complete CozoDB instance in your browser, at near-native speed for most operations! - -So open up the [CozoDB in WASM page](https://www.cozodb.org/wasm-demo/), and then: - -* Follow the [tutorial](https://docs.cozodb.org/en/latest/tutorial.html). - -Or you can skip ahead for the information about installing CozoDB into your favourite environment first. ### Teasers