search

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

Add section for installation instructions #187

Closed remz1337 closed 2 years ago

remz1337 commented 2 years ago

Covers VCPKG and Conda

Martinsos commented 2 years ago

Sorry for slow response @remz1337 , I was on vacation, but now I am back and happy to add this to the codebase!

So right now, README has sections "building" and "using edlib in your project". The second one references "building" if you want to use edlib by linking the built library.

You now added "installation" section. How should a person think about that one in relation to "building" and "using edlib in your project"? In my mind, first thing to look at should probably be "using edlib in your project" and then "building" or "installation" are something you do in order to use edlib in your project, so maybe that is a way to go? One thing to help us with decision making here is understanding what is being installed -> so what does vcpkg install and what does conda install? Do they install edlib CLI? Do they position edlib library somewhere so it can be used in the project? I think we need to answer (and describe) those, and then we can refer to these methods from the "using edlib" section. Let me know if you have a better idea how to organize this, I am open to ideas, as long as we get all 3 sections working together nicely so that they make one coherent whole and it is clear what the developer should do based on their requirements.

remz1337 commented 2 years ago

Hey, no worries, everyone one can take time off :) I get your point. In the case of vcpkg, it simply includes the header in the CMake project so you can call the library from within a program, not from the command line. I agree that "installation" may be misleading in that case and including the VCPKG instructions in the "using edlib in your project" would make more sense. What do you think?

Martinsos commented 2 years ago

Sure, let's do that then! I guess we could have a section in "use edlib" that mentions you can use vcpkg if you are using CMake and any additional instructions (as I mentioned I never used vcpkg and I also don't CMake lately so I can't help much here).

Btw while at it, we could maybe put "use edlib in your own project" above the "Building" section - what do you think? I think that would make sense and I can't remember why I did those in the opposite order.

remz1337 commented 2 years ago

Did the changes, let me know what you think

Martinsos commented 2 years ago

Nice, this looks great! I just realized that part with Conda doesn't fit the whole thing, but this has notihng to do with you, this is how it already was before. The thing is, I am not really sure what consta install edlib does so I am not sure how to approach this. Best to just leave it for now I guess. Cool, I will merge the PR, thanks a lot!