Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #212

Merged
merged 1 commit into from
Oct 31, 2022
Merged

Update README.md #212

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,21 +50,21 @@ Please refer to the file [INSTALL.md](INSTALL.md) for a list of all the
dependencies and how to install them across different platforms.


## Building Speedb
## 🔨 Building Speedb

Debug:

mkdir build && cd build
cmake .. -DCMAKE_BUILD_TYPE=Debug [cmake options]
make rocksdb
make speedb

By default the build type is Debug.

Release:

mkdir build && cd build
cmake .. -DCMAKE_BUILD_TYPE=Release [cmake options]
make rocksdb
make speedb

This will build the static library. If you want to build the dynamic library,
use:
Expand All @@ -82,14 +82,20 @@ For development and functional testing, go with the debug version which includes
more assertions and debug prints. Otherwise, for production or performance
testing, we recommend building a release version which is more optimized.

## 📈 Performance

We are using DBbench to test performance and progress between the versions. it is available under tools and also in the artifact for direct download.
In there you can also find a readme with the commands we are using to get you started.

<img width="769" alt="Screen Shot 2022-10-31 at 15 15 42" src="https://user-images.githubusercontent.com/107058910/199016617-4ecbe279-b281-4a8c-b630-87a509bc09da.png">
shorturl.at/dlKOY
## Questions

- For live discussion with the community you can use our official [Discord channel](https://discord.gg/52yzKZ5G9D).
- For technical questions and discussions you can use our official [Discourse forum](https://speedb.discourse.group/).


## Join us
## 🌎 Join us

Speedb is committed to a welcoming and inclusive environment where everyone can
contribute.
Expand Down