mirror of https://github.com/facebook/duckling.git synced 2024-09-11 21:27:13 +03:00

Julien Odent 161889c3e6 README.md + updating cabal

Summary:
* basic `README.md`
* updated `duckling.cabal`

Reviewed By: JonCoens

Differential Revision: D4691967

fbshipit-source-id: 0a5cdf7

2017-03-10 15:04:23 -08:00

Duckling

Duckling is a Haskell library that parses text into structured data.

Requirements

A Haskell environment is required. We recommend using stack.

To compile and run the binary:

$ stack build
$ stack exec duckling-example-exec

The first time you run it, it will download all required packages.

To run a source file directly (after compiling once):

$ stack ExampleMain.hs

See ExampleMain.hs for an example on how to integrate Duckling in your project.

To regenerate the classifiers and run the tests:

$ stack RegenMain.hs && stack TestMain.hs

Duckling is BSD-licensed. We also provide an additional patent grant.