Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
rubyFeedback opened this issue Oct 30, 2022 · 1 comment · May be fixed by #211
Open

Comments

@rubyFeedback
Copy link

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
Copy link

kojix2 commented Nov 25, 2022

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.

kojix2 added a commit to kojix2/edlib that referenced this issue Nov 25, 2022
@kojix2 kojix2 linked a pull request Nov 25, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants