README.md + updating cabal

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

Reviewed By: JonCoens

Differential Revision: D4691967

fbshipit-source-id: 0a5cdf7
This commit is contained in:
Julien Odent 2017-03-10 14:55:35 -08:00 committed by Facebook Github Bot
parent d5690f5e5e
commit 161889c3e6
2 changed files with 43 additions and 8 deletions

View File

@ -0,0 +1,30 @@
# Duckling
Duckling is a Haskell library that parses text into structured data.
## Requirements
A Haskell environment is required. We recommend using
[stack](https://haskell-lang.org/get-started).
## Quickstart
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
```
## License
Duckling is BSD-licensed. We also provide an additional patent grant.

View File

@ -1,18 +1,23 @@
name: duckling
version: 0.1.0.0
-- synopsis:
-- description:
homepage: https://github.com/githubuser/duckling#readme
license: OtherLicense
synopsis: A Haskell library for parsing text into structured data.
description:
Duckling is a library for parsing text into structured data.
homepage: https://github.com/facebookincubator/duckling#readme
bug-reports: https://github.com/facebookincubator/duckling/issues
license: BSD
license-file: LICENSE
author: Author name here
author: Facebook, Inc.
maintainer: example@example.com
copyright: 2017 Author name here
copyright: Copyright (c) 2014-present, Facebook, Inc.
category: Systems
build-type: Simple
extra-source-files: README.md
stability: alpha
cabal-version: >=1.10
extra-source-files: README.md
, PATENTS
library
exposed-modules: Duckling.Core
, Duckling.Debug
@ -679,4 +684,4 @@ executable duckling-example-exe
source-repository head
type: git
location: https://github.com/githubuser/duckling
location: https://github.com/facebookincubator/duckling