diff options
-rw-r--r-- | Makefile | 8 | ||||
-rw-r--r-- | README | 17 | ||||
-rw-r--r-- | openpgp.cabal | 14 |
3 files changed, 28 insertions, 11 deletions
@@ -3,7 +3,7 @@ HLINTFLAGS=-XHaskell98 -XNoCPP -i 'Use camelCase' -i 'Use String' -i 'Use head' | |||
3 | 3 | ||
4 | .PHONY: all cleas | 4 | .PHONY: all cleas |
5 | 5 | ||
6 | all: verify report.html | 6 | all: verify report.html README |
7 | 7 | ||
8 | verify: examples/verify.hs | 8 | verify: examples/verify.hs |
9 | ghc --make $(GHCFLAGS) -o $@ $^ | 9 | ghc --make $(GHCFLAGS) -o $@ $^ |
@@ -11,6 +11,12 @@ verify: examples/verify.hs | |||
11 | report.html: | 11 | report.html: |
12 | hlint $(HLINTFLAGS) --report Data examples | 12 | hlint $(HLINTFLAGS) --report Data examples |
13 | 13 | ||
14 | README: openpgp.cabal | ||
15 | tail -n+$$(( `grep -n ^description: $^ | head -n1 | cut -d: -f1` + 1 )) $^ > .$@ | ||
16 | head -n+$$(( `grep -n ^$$ .$@ | head -n1 | cut -d: -f1` - 1 )) .$@ > $@ | ||
17 | printf ',s/ //g\n,s/^.$$//g\nw\nq\n' | ed $@ | ||
18 | $(RM) .$@ | ||
19 | |||
14 | clean: | 20 | clean: |
15 | find -name '*.o' -o -name '*.hi' | xargs $(RM) | 21 | find -name '*.o' -o -name '*.hi' | xargs $(RM) |
16 | $(RM) verify | 22 | $(RM) verify |
@@ -1,12 +1,17 @@ | |||
1 | OpenPGP-Haskell | 1 | This is an OpenPGP library inspired by my work on OpenPGP libraries in |
2 | Ruby <https://github.com/singpolyma/openpgp>, | ||
3 | PHP <http://github.com/singpolyma/openpgp-php>, | ||
4 | and Python <https://github.com/singpolyma/OpenPGP-Python>. | ||
2 | 5 | ||
3 | This is an OpenPGP library inspired by my work on OpenPGP-PHP <http://github.com/bendiken/openpgp-php>. | 6 | It defines types to represent OpenPGP messages as a series of packets |
7 | and then defines instances of Data.Binary for each to facilitate | ||
8 | encoding/decoding. | ||
4 | 9 | ||
5 | It defines types Message and Packet to represent OpenPGP messages as series of packets and then defines instances of Data.Binary for each to facilitate encoding/decoding. | 10 | There is also a wrapper around <http://hackage.haskell.org/package/Crypto> |
11 | that currently does fingerprint generation and signature verification. | ||
6 | 12 | ||
7 | There is also a wrapper around <http://hackage.haskell.org/package/Crypto> that currently does fingerprint generation and signature verification. | 13 | It is intended that you use qualified imports with this library. If importing |
8 | 14 | both modules, something like this will do: | |
9 | It is intended that you use qualified imports with this library. If importing both modules, something like this will do: | ||
10 | 15 | ||
11 | > import qualified Data.OpenPGP as OpenPGP | 16 | > import qualified Data.OpenPGP as OpenPGP |
12 | > import qualified Data.OpenPGP.Crypto as OpenPGP | 17 | > import qualified Data.OpenPGP.Crypto as OpenPGP |
diff --git a/openpgp.cabal b/openpgp.cabal index eb6146c..69aec0f 100644 --- a/openpgp.cabal +++ b/openpgp.cabal | |||
@@ -13,15 +13,21 @@ synopsis: Implementation of the OpenPGP message format | |||
13 | homepage: http://github.com/singpolyma/OpenPGP-Haskell | 13 | homepage: http://github.com/singpolyma/OpenPGP-Haskell |
14 | bug-reports: http://github.com/singpolyma/OpenPGP-Haskell/issues | 14 | bug-reports: http://github.com/singpolyma/OpenPGP-Haskell/issues |
15 | build-type: Simple | 15 | build-type: Simple |
16 | description: This is an OpenPGP library inspired by my work on OpenPGP-PHP <http://github.com/bendiken/openpgp-php>. | 16 | description: |
17 | It defines types Message and Packet to represent OpenPGP messages as series | 17 | This is an OpenPGP library inspired by my work on OpenPGP libraries in |
18 | of packets and then defines instances of Data.Binary for each to facilitate | 18 | Ruby <https://github.com/singpolyma/openpgp>, |
19 | PHP <http://github.com/singpolyma/openpgp-php>, | ||
20 | and Python <https://github.com/singpolyma/OpenPGP-Python>. | ||
21 | . | ||
22 | It defines types to represent OpenPGP messages as a series of packets | ||
23 | and then defines instances of Data.Binary for each to facilitate | ||
19 | encoding/decoding. | 24 | encoding/decoding. |
20 | . | 25 | . |
21 | There is also a wrapper around <http://hackage.haskell.org/package/Crypto> | 26 | There is also a wrapper around <http://hackage.haskell.org/package/Crypto> |
22 | that currently does fingerprint generation and signature verification. | 27 | that currently does fingerprint generation and signature verification. |
23 | . | 28 | . |
24 | It is intended that you use qualified imports with this library. If importing both modules, something like this will do: | 29 | It is intended that you use qualified imports with this library. If importing |
30 | both modules, something like this will do: | ||
25 | . | 31 | . |
26 | > import qualified Data.OpenPGP as OpenPGP | 32 | > import qualified Data.OpenPGP as OpenPGP |
27 | > import qualified Data.OpenPGP.Crypto as OpenPGP | 33 | > import qualified Data.OpenPGP.Crypto as OpenPGP |