Browse Source

add readme and travis

Pat Hickey 9 years ago
parent
commit
8101aca925
2 changed files with 32 additions and 0 deletions
  1. 15 0
      .travis.yml
  2. 17 0
      README.md

+ 15 - 0
.travis.yml

@@ -0,0 +1,15 @@
+language: haskell
+
+
+before_install:
+  - git clone https://github.com/galoisinc/ivory
+  - export IVORY_REPO=$PWD/ivory
+install:
+  - cabal install alex
+  - cabal install happy
+script:
+  - IVORY_REPO=$IVORY_REPO make create-sandbox
+  - IVORY_REPO=$IVORY_REPO make
+  - IVORY_REPO=$IVORY_REPO make test
+ghc:
+  - 7.8

+ 17 - 0
README.md

@@ -0,0 +1,17 @@
+# Gidl
+
+Gidl (for Galois Interface Description Language) is a simple IDL for
+describing structured types
+
+## IDL format
+
+See example in tests/example.idl.
+
+## Backend
+
+Gidl currently has a native Haskell backend. Ivory language backend coming soon.
+
+## Tests
+
+Use the `test` target in the Makefile to generate and test a Haskell library
+for the IDL file.