Skip to content

Commit

Permalink
Merge pull request #44 from stefanmb/stefanmb/build_instructions
Browse files Browse the repository at this point in the history
README: Add source build instructions
  • Loading branch information
feixue1121 authored Oct 16, 2024
2 parents 7dabf35 + 592f829 commit a4b3aa9
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,23 @@ docker exec -it myscaledb-myscaledb-1 clickhouse-client

5. You can now run SQL statements. See [Executing SQL Queries](https://myscale.com/docs/en/quickstart/#executing-sql-queries).

#### Building from source

The supported build environment is Ubuntu 22.04 with LLVM 15.0.7.

Please see the [scripts](https://github.com/myscale/MyScaleDB/tree/main/scripts) folder.

Example usage:

```bash
LLVM_VERSION=15 sudo -E bash scripts/install_deps.sh
sudo apt-get -y install rustc cargo yasm
bash scripts/config_on_linux.sh
bash scripts/build_on_linux.sh
```

The resulting executables will be in `MyScaleDB/build/programs/*`.

## Tutorial

See [Vector Search Documentation](https://myscale.com/docs/en/vector-search/) for how to create a SQL table with vector index and perform vector search. It's recommended to specify `TYPE SCANN` when creating a vector index in open source MyScaleDB.
Expand Down

0 comments on commit a4b3aa9

Please sign in to comment.