Skip to content

Commit d0e0e87

Browse files
committed
chore: add README
1 parent 1fff020 commit d0e0e87

File tree

3 files changed

+23
-6
lines changed

3 files changed

+23
-6
lines changed

Contributing.md

Whitespace-only changes.

README.md

+23-6
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,42 @@
11
# LeanStore
22

3+
![Architecture](./docs/images/Architecture.jpg)
4+
35
[LeanStore](https://db.in.tum.de/~leis/papers/leanstore.pdf) is a
46
high-performance OLTP storage engine optimized for many-core CPUs and NVMe SSDs.
57
Our goal is to achieve performance comparable to in-memory systems when the data
68
set fits into RAM, while being able to fully exploit the bandwidth of fast NVMe
79
SSDs for large data sets. While LeanStore is currently a research prototype, we
810
hope to make it usable in production in the future.
911

10-
## Build and Run
12+
## Getting started
1113

12-
Ubuntu 12.04 or newer is required. Install the following packages:
14+
> NOTE: Ubuntu 22.04 or newer and GCC 12 is required.
1315
1416
```sh
17+
# install dependencies
1518
sudo apt-get update
1619
sudo apt-get install -y libaio-dev
17-
```
18-
19-
Build the project with CMake:
2020

21-
```sh
21+
# build
2222
cmake -DCMAKE_BUILD_TYPE=Debug -B build -S .
2323
cmake --build build -j `nproc`
2424
ctest --test-dir build -j `nproc`
2525
```
26+
27+
## Contributing
28+
29+
Contributions are welcomed and greatly appreciated! "good-first-issue" is a good
30+
start point, see the [Contributing](./Contributing.md) file for details about the contributing
31+
workflow, develop guide, and contributor communication etc.
32+
33+
## License
34+
35+
LeanStore is under the MIT License. See the [LICENSE](./LICENSE) file for
36+
details.
37+
38+
## Acknowledgments
39+
40+
Thanks the LeanStore authors for the great
41+
[leanstore](http://github.com/leanstore/leanstore) project and the idea behind
42+
it.

docs/images/Architecture.jpg

321 KB
Loading

0 commit comments

Comments
 (0)