Issue #1 new

Installation docs recommended

odigity
created an issue

Platform: Ubuntu 13.04, x86_64

Just came across Treequel while googling for a ruby LDAP library to use to write clients to test/play with OpenLDAP, which I recently started learning.

When installing treequel, it twice failed with an error referring to various header files that were missing. I had to use google searches and apt-get commands to finally guess at which packages were needed and get them installed before the treequel install worked:

libldap-dev libsasl2-dev

Also noticed the installation printed a message about the treequel command-line tools no longer being included, so had to install treequel-shell afterwards.

Would be nice if all of the above were covered in the README to make the new-user experience as smooth as possible.

Extra credit: Mention that treequel... a) wraps the standard ldap C libraries from the OpenLDAP project and therefore requires building, unlike a pure-ruby implementation b) also pulls in the ruby-ldap gem, and why

Comments (3)

  1. Michael Granger repo owner

    Treequel doesn't wrap the C libraries itself, that's what it uses ruby-ldap for, but your point is well-taken.

    I do think a little help section for getting ruby-ldap installed in the README would be great, but the problem (as with any Ruby library that includes an extension) is which platforms do we document? Obviously, telling people to install libldap-dev and libsasl2-dev isn't going to be helpful to someone on a Mac, or on FreeBSD, etc. I guess we can just come up with something generic and then list the requirements for several well-known platforms.

    Thanks for this suggestion!

  2. odigity reporter

    Good point regarding different platforms. I always underestimate the complexity of covering the basics in a multi-platform world. :)

  3. Log in to comment