[Date Prev][Date Next] [Chronological] [Thread] [Top]

Re: Will lmdb suit my needs ?

First of all, thanks for the helpful response :)

> Can you give an example of a tutorial from another project that
> explains things in a way you find helpful?  Improving documentation
> and new-developer accessibility is an ongoing problem.

I wanted something on the lines of:

http://leveldb.googlecode.com/svn/trunk/doc/index.html or
http://www.sqlite.org/cintro.html

A walk through of how to create a database, how to insert data and how
to query them. Sure the API docs exist, but a document introducing the
APIs in a flow that consumers will want, will be more helpful than a
page that merely documents all the APIs in no related
grouping/ordering.

The sample-mdb.txt that you have linked above is pretty useful, as an
introductory material.

The main page http://symas.com/mdb/doc/index.html can include a
reference to the sample-mdb.txt file that you referred to. It will be
even better if it is renamed to a .c file which the users can just
download and use. If you put it as a [github] gist (with syntax
highlighting colors etc.), it will be even more helpful. People can
star the gist and can easily refer to it anytime.

> As we obviously have that, how can we make it more clear and easy to
locate?

You can add a "Source" link in the top bar in http://symas.com/mdb/ .
There is a source section in that page but it does not have a link on
the page top. So the information is lost if the users are not reading
through the page fully.

Since most of the consumers (I am biased for application developers
who want to use an in-process database for their app) will use github
for their personal source code management, it may be useful to have a
mirror for lmdb in github (just like gitorious), if there are no
philosophical conflicts.

Thanks again.

-- 
Sankar P
http://psankar.blogspot.com