search

Simmetrics / simmetrics

Similarity or Distance Metrics, e.g. Levenshtein, for Java
Apache License 2.0
340 stars 77 forks source link

Online Documentation #30

Open Bergmaier opened 5 years ago

Bergmaier commented 5 years ago

Hi, this seems a very advanced library and in many aspects better than its competitors, but I cannot find any good documentation besides the readme - which links directly into the source of some java source files. Is there any html javadoc website available?

kinow commented 5 years ago

Good idea @Bergmaier. Whenever I have to see how to use a metric, for now I just resort to looking at the tests.

mpkorstanje commented 5 years ago

@Bergmaier I'm afraid viewing the example section on github is the best I can offer. While it is java code, I've structured in such away that it should be quite informative.

If any one wants to improve on it please feel free to send a PR.