Updates readme
This commit is contained in:
parent
a2ee78dcd4
commit
2011ef7fbb
14
README.md
14
README.md
|
@ -54,10 +54,22 @@ Iterate over subset of database content:
|
||||||
|
|
||||||
## Compiling with optimizations
|
## 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 <unistd.h> `--passC:-DHAVE_FDATASYNC=1`
|
- fdatasync from <unistd.h> `--passC:-DHAVE_FDATASYNC=1`
|
||||||
- F_FULLSYNC from <fcntl.h> `--passC:-DHAVE_FULLFSYNC=1`
|
- F_FULLSYNC from <fcntl.h> `--passC:-DHAVE_FULLFSYNC=1`
|
||||||
- O_CLOEXEC from <fcntl.h> `--passC:-DHAVE_O_CLOEXEC=1`
|
- O_CLOEXEC from <fcntl.h> `--passC:-DHAVE_O_CLOEXEC=1`
|
||||||
- crc32c from <crc32c/crc32c.h> `--passC:-DHAVE_CRC32C=1`
|
- crc32c from <crc32c/crc32c.h> `--passC:-DHAVE_CRC32C=1`
|
||||||
- snappy from <snappy.h> `--passC:-DHAVE_SNAPPY=1`
|
- snappy from <snappy.h> `--passC:-DHAVE_SNAPPY=1`
|
||||||
- zstd from <zstd.h> `--passC:-DHAVE_ZSTD=1`
|
- zstd from <zstd.h> `--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.
|
||||||
|
|
Loading…
Reference in New Issue