summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Makefile8
-rw-r--r--README17
-rw-r--r--openpgp.cabal14
3 files changed, 28 insertions, 11 deletions
diff --git a/Makefile b/Makefile
index 938b8c2..b2e6829 100644
--- a/Makefile
+++ b/Makefile
@@ -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
6all: verify report.html 6all: verify report.html README
7 7
8verify: examples/verify.hs 8verify: examples/verify.hs
9 ghc --make $(GHCFLAGS) -o $@ $^ 9 ghc --make $(GHCFLAGS) -o $@ $^
@@ -11,6 +11,12 @@ verify: examples/verify.hs
11report.html: 11report.html:
12 hlint $(HLINTFLAGS) --report Data examples 12 hlint $(HLINTFLAGS) --report Data examples
13 13
14README: 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
14clean: 20clean:
15 find -name '*.o' -o -name '*.hi' | xargs $(RM) 21 find -name '*.o' -o -name '*.hi' | xargs $(RM)
16 $(RM) verify 22 $(RM) verify
diff --git a/README b/README
index feb4c05..2272024 100644
--- a/README
+++ b/README
@@ -1,12 +1,17 @@
1OpenPGP-Haskell 1This is an OpenPGP library inspired by my work on OpenPGP libraries in
2Ruby <https://github.com/singpolyma/openpgp>,
3PHP <http://github.com/singpolyma/openpgp-php>,
4and Python <https://github.com/singpolyma/OpenPGP-Python>.
2 5
3This is an OpenPGP library inspired by my work on OpenPGP-PHP <http://github.com/bendiken/openpgp-php>. 6It defines types to represent OpenPGP messages as a series of packets
7and then defines instances of Data.Binary for each to facilitate
8encoding/decoding.
4 9
5It 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. 10There is also a wrapper around <http://hackage.haskell.org/package/Crypto>
11that currently does fingerprint generation and signature verification.
6 12
7There is also a wrapper around <http://hackage.haskell.org/package/Crypto> that currently does fingerprint generation and signature verification. 13It is intended that you use qualified imports with this library. If importing
8 14both modules, something like this will do:
9It 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
13homepage: http://github.com/singpolyma/OpenPGP-Haskell 13homepage: http://github.com/singpolyma/OpenPGP-Haskell
14bug-reports: http://github.com/singpolyma/OpenPGP-Haskell/issues 14bug-reports: http://github.com/singpolyma/OpenPGP-Haskell/issues
15build-type: Simple 15build-type: Simple
16description: This is an OpenPGP library inspired by my work on OpenPGP-PHP <http://github.com/bendiken/openpgp-php>. 16description:
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