Commit bb019dbc authored by Philipp Götze's avatar Philipp Götze
Browse files

📚 Consistent formatting in README.md

parent 1265a114
NVM-based Data Strucutres
=========================
[![pipeline status](https://dbgit.prakinf.tu-ilmenau.de/code/nvm-based_data_structures/badges/master/pipeline.svg)](https://dbgit.prakinf.tu-ilmenau.de/code/nvm-based_data_structures/commits/master)
[![coverage report](https://dbgit.prakinf.tu-ilmenau.de/code/nvm-based_data_structures/badges/master/coverage.svg?job=coverage)](https://dbgit.prakinf.tu-ilmenau.de/code/nvm-based_data_structures/commits/master)
This is a repository for persistent data structures based on non-volatile memory (NVM).
## :sparkles: TODOs: ##
:sparkles: TODOs
----------------
- [x] ~~PBPTree (B⁺-Tree for NVM)~~
- [x] ~~PTable (BDCC + NVM)~~
- [x] ~~Steffen's implementations~~
......@@ -15,11 +19,15 @@ This is a repository for persistent data structures based on non-volatile memory
- [ ] Data structure common benchmark
- [ ] Documentation
## :copyright: License ##
:copyright: License
-------------------
The structures are licensed under GPLv3.
Please see the file [COPYING](COPYING) for detailed license information.
## :heavy_plus_sign: Requirements ##
:heavy_plus_sign: Requirements
------------------------------
- C++ Compiler supporting C++17
- PMDK >= 1.5
......@@ -31,30 +39,37 @@ Please see the file [COPYING](COPYING) for detailed license information.
> **NOTE**: When installing via package manager - libpmemobj++-dev(el) should install the dependencies above, too.
- Emulated NVM device [pmem.io](http://pmem.io/2016/02/22/pm-emulation.html) (optional)
:gear: Build
------------
## :gear: Build ##
Configurations can be found in [src/CMakeLists.txt](src/CMakeLists.txt).
```
```bash
mkdir build; cd build
cmake ../src
make -j
```
Tests and benchmarks, if enabled, can be either manually executed from the ```build``` folder or run at once with:
```
```bash
make test
```
### :whale: Docker ###
:whale: Docker
--------------
There is also the option to create a Docker container.
For this you can either download a pre-built docker image: ```docker pull dbisilm/nvm-based_data_structures```
For this you can either download a pre-built docker image: ```docker pull dbisilm/nvm-based_data_structures```
or built it yourself (in project root directory) with: ```docker build .```
After this you can start the container and bash login with e.g.:
```
```bash
docker run --rm -i -t dbisilm/nvm-based_data_structures /bin/bash
```
:books: Documentation
---------------------
## :books: Documentation ##
:construction:
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment