Martinsos / edlib

Lightweight, super fast C/C++ (& Python) library for sequence alignment using edit (Levenshtein) distance.
http://martinsos.github.io/edlib
MIT License
492 stars 162 forks source link

[Documentation] (1) mention ruby-bindings and (2) mention "why use edlib" in the main README #208

Open rubyFeedback opened 1 year ago

rubyFeedback commented 1 year ago

Hey guys,

I just found the project via kojix2 indirectly, as he wrote the ruby bindings here:

https://github.com/kojix2/ruby-edlib

I did not ask him or sync with him, but perhaps he may appreciate if you guys would also mention his bindings in the main README. :)

Anyway.

I just installed edlib; next step for me will be to test kojix2 bindings. But when I had a look at the main README I was wondering "why would I use edlib".

Note - I think I use some slower ruby solution to calculate edit distance / levensthein distance. So I am quite clueless here. But I think it would be useful if you guys could either add to the FAQ "why use edlib" (yes, silly question but people may ask it), and, if there are other alternatives, perhaps also add a table that could mention a few differences? You kind of list reasons for edlib in the intro but I think a short, succinct table near the end of the README would be very convenient for "first time visitors". Simply something that gives us a reason to use edlib, as opposed to xyz software elsewhere (and that is a genuine request, I really currently have no idea. Perhaps benchmarks could be added for comparison but you guys have a finite amount of time and I don't want to make this request taking too long of your unpaid spare time either.)

kojix2 commented 1 year ago

Hello, I found this today.

I don't think it is necessary to put it in the README as it is already explained in detail in the paper as to why we use edlib. doi: 10.1093/bioinformatics/btw753 There are often projects where papers are listed at the top of the README, but I personally don't like those. In other words, the current README is sufficient for me.

However, if you could include the Ruby bindings in the README, that would be great, and I will send you a PR.

Thanks.