34 lines
762 B
Markdown
34 lines
762 B
Markdown
## Storage Engine Playground
|
|
|
|
This repo is a playground for running small experiments related to storage side of things.
|
|
|
|
### Development
|
|
|
|
> ⚠️ Clone with `--recursive`.
|
|
> The repo pulls `external/geolog` and `external/geomerge` as git submodules;
|
|
> a non-recursive clone leaves those directories empty and breaks the build.
|
|
|
|
```sh
|
|
# Clone the repo with submodules
|
|
git clone --recursive git@code.obsidian.systems:habedi-work/storage-engine-playground.git
|
|
```
|
|
|
|
```sh
|
|
# Enter the development environment
|
|
nix develop
|
|
```
|
|
|
|
#### Makefile Targets
|
|
|
|
```sh
|
|
make format # Format Rust code
|
|
make lint # Run linter checks
|
|
make test # Run tests
|
|
```
|
|
|
|
Run `make help` to see all the available targets.
|
|
|
|
### Crates
|
|
|
|
Check out the [crates](crates) directory for more details.
|