From 2011ef7fbb8ed675bafec7b65bd9069019052761 Mon Sep 17 00:00:00 2001 From: Ben Date: Tue, 21 May 2024 13:58:29 +0200 Subject: [PATCH] Updates readme --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 31f8ddf..bc93154 100644 --- a/README.md +++ b/README.md @@ -54,10 +54,22 @@ Iterate over subset of database content: ## Compiling with optimizations -This library can be compiled with the following optimization options. By default these are disabled. Provide the following nim compiler flags to enable them: +CMake is used during compilation to determine which of the following optimization options are enabled. You can set the following nim compiler flags to 0 or 1 to override them: - fdatasync from `--passC:-DHAVE_FDATASYNC=1` - F_FULLSYNC from `--passC:-DHAVE_FULLFSYNC=1` - O_CLOEXEC from `--passC:-DHAVE_O_CLOEXEC=1` - crc32c from `--passC:-DHAVE_CRC32C=1` - snappy from `--passC:-DHAVE_SNAPPY=1` - zstd from `--passC:-DHAVE_ZSTD=1` + +## Updating + +When you want to update this library to a new version of LevelDB, follow these steps: +- Update LevelDB submodule to new version. +- Run 'build.sh'. +- Run 'nimble build' and 'nimble test'. +- Make sure everything's working. +- Increment version of this library in 'leveldbstatic.nimble'. +- Commit the changes. +- Tag the commit with the new version number. +- Push.