https://github.com/geneweb/phonetic
https://github.com/geneweb/phonetic
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/geneweb/phonetic
- Owner: geneweb
- License: mit
- Created: 2019-06-26T12:58:01.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-09-11T07:46:15.000Z (almost 7 years ago)
- Last Synced: 2025-01-05T08:55:14.634Z (over 1 year ago)
- Language: OCaml
- Size: 28.3 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
# phonetic
Phonetic algorithm in OCaml
| | Linux | macOS |
| ---: | :---: | :---: |
| OCaml 4.05 | ![linux-ocaml4.05] | ![macos-ocaml4.05] |
| OCaml 4.06 | ![linux-ocaml4.06] | ![macos-ocaml4.06] |
| OCaml 4.07 | ![linux-ocaml4.07] | ![macos-ocaml4.07] |
| OCaml 4.08 | ![linux-ocaml4.08] | ![macos-ocaml4.08] |
[linux-ocaml4.05]:https://travis-matrix-badges.herokuapp.com/repos/geneweb/phonetic/branches/master/1
[linux-ocaml4.06]:https://travis-matrix-badges.herokuapp.com/repos/geneweb/phonetic/branches/master/2
[linux-ocaml4.07]:https://travis-matrix-badges.herokuapp.com/repos/geneweb/phonetic/branches/master/3
[linux-ocaml4.08]:https://travis-matrix-badges.herokuapp.com/repos/geneweb/phonetic/branches/master/4
[macos-ocaml4.05]:https://travis-matrix-badges.herokuapp.com/repos/geneweb/phonetic/branches/master/5
[macos-ocaml4.06]:https://travis-matrix-badges.herokuapp.com/repos/geneweb/phonetic/branches/master/6
[macos-ocaml4.07]:https://travis-matrix-badges.herokuapp.com/repos/geneweb/phonetic/branches/master/7
[macos-ocaml4.08]:https://travis-matrix-badges.herokuapp.com/repos/geneweb/phonetic/branches/master/8
## Installation
```bash
opam install phonetic
```
## What's inside
- `DoubleMetaphone.double_metaphone`:
[Double Metaphone (Wikipedia)](https://en.wikipedia.org/wiki/Metaphone#Double_Metaphone)
- `Soundex.soundex`:
[Soundex (Wikipedia)](https://en.wikipedia.org/wiki/Soundex)
## Instructions for developpers
```bash
dune build # build the library
dune install # install the built library
dune runtest # run unit tests
dune build @runbench # run benchmark
dune clean # clean compilation artifacts
```