Update README to contain a quick start guide for speedb #18

AmnonHanuhov · 2022-06-20T18:14:27Z

AmnonHanuhov · 2022-06-20T18:16:17Z

udi-speedb · 2022-06-22T08:43:55Z

README.md

@@ -1,32 +1,59 @@
-## RocksDB: A Persistent Key-Value Store for Flash and RAM Storage
+# SpeeDB: A drop in replacement embedded solution for RocksDB


Are we indeed a drop-in replacement? Is that our approved marketing message? Just verifying

The basic comment I have is that this is indeed a quick-start guide as the name of the branch implies, BUT, quoting from https://www.freecodecamp.org/news/how-to-write-a-good-readme-file/: "In simple words, we can describe a README file as a guide that gives users a detailed description of a project you have worked on" (this matches multiple other pages describing the purpose / expected content of a README file).
We are replacing RocksDB's README (that does include this info). So, IMO, either we refer to that file for more information, or write our own (in case we would like to also be a drop-in replacement of the README file)

What is our project?

Why are we developing a drop-in replacement for RocksDB (assuming we indeed provide a drop-in replacement)?

What is our vision?
Etc.
The rest of my comments below will just assume that the comment above has been addressed.

@udi-speedb, There's a separate thread on OSS marketing happening. I created issue #45 to update the README.

@AmnonHanuhov let's be consistent and use the Speedb spelling everywhere rather than SpeeDB.

udi-speedb · 2022-06-22T08:46:40Z

README.md

+`TODO:` This section should point the reader to a dedicated file explaining how to contribute
+
+## License
+SpeeDB is licensed under Apache 2.0


Where can I find the license?

@rtpro care to elaborate on this?

@udi There's a LICENSE file in the root directory. I've created another issue #46 to update the license according to the license requirements.

README.md

udi-speedb · 2022-06-22T08:49:38Z

README.md


-See the [github wiki](https://github.com/facebook/rocksdb/wiki) for more explanation.


Shouldn't we point to our own wiki?

This line was removed because I didn't want to point to the rocksdb wiki. Do we have a wiki that I can mention here?

There's work going on to create Speedb Documentation. We will link it once it's up.

README.md

udi-speedb · 2022-06-22T08:58:37Z

README.md

+
+## Usage
+Usage of the library in your code is the same, regardless of whether you statically linked the library or dynamically linked it, and examples can be found under the https://github.com/speedb-io/speedb/tree/main/examples directory.
+The public interface is in `include/`. Callers should not include or rely on the details of any other header files in this package. Those internal APIs may be changed without warning.


This may be the intention but doesn't hold in practice (I personally had to include a header that is in a different folder for my new filter type, and I have done this after discussion with @mrambacher)

README.md

udi-speedb · 2022-06-22T09:01:33Z

README.md

+	mkdir build && cd build   
+	cmake .. [cmake options] -GNinja
+    ninja
+


Do we not mention make on purpose?
Are we advocating cmake as the only supported build system?

Ideally I would want us to have a cmake script, I opened a ticket for it on Jira https://speedb.atlassian.net/jira/software/projects/SPDB/boards/1/backlog?assignee=61e4062385a2d60070295e91&selectedIssue=SPDB-711
But to answer your question, this is something that should probably be discussed with the rest of the r&d team. Whether we want to set a standard of compiling with cmake (the cmake script I mentioned above), or mention make here as well, or maybe both.

README.md

isaac-io · 2022-07-12T11:42:41Z

README.md

@@ -1,32 +1,59 @@
-## RocksDB: A Persistent Key-Value Store for Flash and RAM Storage
+# SpeeDB: A drop in replacement embedded solution for RocksDB


@AmnonHanuhov let's be consistent and use the Speedb spelling everywhere rather than SpeeDB.

README.md

AmnonHanuhov added the documentation Improvements or additions to documentation label Jun 20, 2022

AmnonHanuhov requested a review from udi-speedb June 20, 2022 18:14

AmnonHanuhov self-assigned this Jun 20, 2022

AmnonHanuhov force-pushed the amnon/quick_start_guide branch from 0a4eca2 to d64a561 Compare June 20, 2022 19:15

udi-speedb reviewed Jun 22, 2022

View reviewed changes

AmnonHanuhov force-pushed the amnon/quick_start_guide branch 2 times, most recently from e8ddf4c to f1d31ed Compare June 22, 2022 15:26

Yuval-Ariel force-pushed the main branch from 17b4b7f to 336cab6 Compare June 22, 2022 16:42

AmnonHanuhov force-pushed the amnon/quick_start_guide branch 4 times, most recently from a8716c6 to 05355ee Compare July 9, 2022 09:26

isaac-io suggested changes Jul 13, 2022

View reviewed changes

AmnonHanuhov force-pushed the amnon/quick_start_guide branch 3 times, most recently from 3753450 to 81a2848 Compare July 13, 2022 17:07

rtpro approved these changes Jul 14, 2022

View reviewed changes

rtpro requested a review from isaac-io July 14, 2022 15:49

AmnonHanuhov force-pushed the amnon/quick_start_guide branch from 81a2848 to a02d090 Compare July 14, 2022 16:01

Update README to contain a quick start guide for speedb

83ebebe

AmnonHanuhov force-pushed the amnon/quick_start_guide branch from a02d090 to 83ebebe Compare July 14, 2022 16:03

isaac-io approved these changes Jul 14, 2022

View reviewed changes

isaac-io merged commit b826def into main Jul 14, 2022

isaac-io deleted the amnon/quick_start_guide branch July 20, 2022 11:55

isaac-io mentioned this pull request Jul 20, 2022

23 spdb write flow #60

Closed

udi-speedb mentioned this pull request Nov 10, 2022

db_bench: Fix a RocksDB bug in the cleanup of a Benchmark when using multiple DBs (-num_multi_db) #234

Closed

udi-speedb mentioned this pull request Dec 7, 2022

Generate a concise report / csv file conveniently listing the failures in make check #288

Open

erez-speedb mentioned this pull request Dec 20, 2022

Improve spdb memtable performance #298

Closed

Yuval-Ariel mentioned this pull request Jan 17, 2023

ZSTD stress asan error #367

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update README to contain a quick start guide for speedb #18

Update README to contain a quick start guide for speedb #18

AmnonHanuhov commented Jun 20, 2022 •

edited

Loading

AmnonHanuhov commented Jun 20, 2022

udi-speedb Jun 22, 2022

rtpro Jul 10, 2022

isaac-io Jul 12, 2022

udi-speedb Jun 22, 2022

AmnonHanuhov Jun 22, 2022

rtpro Jul 10, 2022

udi-speedb Jun 22, 2022

AmnonHanuhov Jun 22, 2022

rtpro Jul 10, 2022

udi-speedb Jun 22, 2022

udi-speedb Jun 22, 2022

AmnonHanuhov Jun 22, 2022

isaac-io Jul 12, 2022

		@@ -1,32 +1,59 @@
		## RocksDB: A Persistent Key-Value Store for Flash and RAM Storage
		# SpeeDB: A drop in replacement embedded solution for RocksDB


		See the [github wiki](https://github.com/facebook/rocksdb/wiki) for more explanation.

Update README to contain a quick start guide for speedb #18

Update README to contain a quick start guide for speedb #18

Conversation

AmnonHanuhov commented Jun 20, 2022 • edited Loading

AmnonHanuhov commented Jun 20, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AmnonHanuhov commented Jun 20, 2022 •

edited

Loading