Added library hint in readme

reactive-systems · Jul 3, 2017 · 8aceb00 · 8aceb00
1 parent 96b4245
commit 8aceb00
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 3 deletions.
diff --git a/README b/README
@@ -1,5 +1,5 @@
 # Synthesis Format Conversion Tool
-# (Version 1.0.0.27)
+# (Version 1.0.0.28)
 
 A tool for reading, manipulating and transforming synthesis
 specifications in TLSF [0].
@@ -202,6 +202,16 @@ syfco [OPTIONS]... <file>
 A number of synthesis benchmarks in TLSF can be found in the
 /examples directory.
 
+## Syfco Library
+
+Syfco is also provided as a Haskell library. In fact, the syfco
+executable is nothing different than a fancy command line interface
+to this library. If you are interested in using the interface, we
+recommend to build and check the interface documentation, which is
+generated by:
+
+  make haddock
+
 ## Editor Support
 
 If you use Emacs [12], you should try our emacs mode (tlsf-mode.el),

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Synthesis Format Conversion Tool<br/>(Version 1.0.0.27)
+# Synthesis Format Conversion Tool<br/>(Version 1.0.0.28)
 
 A tool for reading, manipulating and transforming synthesis
 specifications in [TLSF](https://arxiv.org/abs/1604.02284).
@@ -161,6 +161,16 @@ syfco -t file.tlsf
 A number of synthesis benchmarks in TLSF can be found in the
 ```/examples``` directory.
 
+## Syfco Library
+
+Syfco is also provided as a Haskell library. In fact, the syfco
+executable is nothing different than a fancy command line interface
+to this library. If you are interested in using the interface, we
+recommend to build and check the interface documentation, which is
+generated by:
+
+`make haddock`
+
 ## Editor Support
 
 If you use [Emacs](https://www.gnu.org/software/emacs), you should try our emacs mode (```tlsf-mode.el```),

diff --git a/src/Info.hs b/src/Info.hs
@@ -642,6 +642,16 @@ readme m = appendlinks $ unlines
   , "A number of synthesis benchmarks in TLSF can be found in the"
   , code m "/examples" ++ " directory."
   , ""
+  , "## Syfco Library"
+  , ""
+  , "Syfco is also provided as a Haskell library. In fact, the syfco"
+  , "executable is nothing different than a fancy command line interface"
+  , "to this library. If you are interested in using the interface, we"
+  , "recommend to build and check the interface documentation, which is"
+  , "generated by:"
+  , ""
+  , scb "make haddock"
+  , ""
   , "## Editor Support"
   , ""
   , "If you use " ++ link "Emacs" "https://www.gnu.org/software/emacs" ++

diff --git a/syfco.cabal b/syfco.cabal
@@ -1,5 +1,5 @@
 name:                syfco
-version:             1.0.0.27
+version:             1.0.0.28
 synopsis:            Synthesis Format Conversion Tool / Library
 description:         Library and tool for reading, manipulating and transforming synthesis specifications.
 license:             MIT