urbit-hob

commit f8957200f05ffce4f2350f1b3d9a2c914b7d0ee2
parent bc1e4b24792df3256529f4d898721e966f4c0231
Author: Jared Tobin <jared@jtobin.io>
Date:   Fri,  6 Sep 2019 15:35:52 -0230

meta: touch up cabal file

Diffstat:
M
urbit-hob.cabal
 | 
37
++++++++++++++++++++++++++++++++++---

1 file changed, 34 insertions(+), 3 deletions(-)
diff --git a/urbit-hob.cabal b/urbit-hob.cabal
@@ -1,26 +1,57 @@
 name:           urbit-hob
 version:        0.1.0
-description:    Hoon-style atom manipulation and printing functions
+synopsis:       Hoon-style atom manipulation and printing functions
 homepage:       https://github.com/urbit/urbit-hob#readme
 bug-reports:    https://github.com/urbit/urbit-hob/issues
 author:         Jared Tobin
 maintainer:     jared@jtobin.io
 copyright:      2019 Jared Tobin
+category:       Urbit
 license:        MIT
 license-file:   LICENSE
 build-type:     Simple
 cabal-version:  >= 1.10
+description:
+  Here you can primarily find functions for dealing with the "patp" phonetic
+  base used by Urbit.  The '@p' encoding is used for naming ships; it uniquely
+  represents a 32-bit number in a memorable and pronounceable fashion.
+  .
+  The '@p' encoding is an obfuscated representation of an underlying 32-bit
+  number, in particular, hence the 'ob' in the library's name.
+  .
+  The library exposes two functions, 'patp' and 'fromPatp', for converting
+  between representations.  You can render a 'Patp' value via the 'render'
+  function.
+  .
+  Here's a quick example:
+  .
+  > import qualified Urbit.Ob as Ob
+  >
+  > let nidsut = Ob.patp 15663360
+  > Ob.render nidsut
+  "~nidsut-tomdun"
+  > Ob.fromPatp nidsut
+  15663360
 
 source-repository head
   type: git
   location: https://github.com/urbit/urbit-hob
 
+flag release
+  Description:       Build for release
+  Default:           False
+  Manual:            True
+
 library
   default-language: Haskell2010
   hs-source-dirs:   lib
   other-modules:    Paths_hob
-  ghc-options:
-    -Wall -Werror
+
+  if flag(release)
+    ghc-options:     -Wall -Werror
+  else
+    ghc-options:     -Wall
+
   exposed-modules:
       Urbit.Ob
     , Urbit.Ob.Co