shannon-fano 0.1.0.0 → 0.1.0.1

raw patch · 2 files changed

+22/−3 lines, 2 files

Files

• README.md +21/−2
• shannon-fano.cabal +1/−1

@@ -8,16 +8,35 @@  ## Installing / Getting started -I'm currently working to get this library on Hackage. So meanwhile-you can start using it by building it.+### Cabal +This package is now availablein Hackage at https://hackage.haskell.org/package/shannon-fano-0.1.0.0++So you just need to:+ ```shell+$ cabal update+$ cabal install shannon-fano+```++### Manually++```shell $ git clone https://github.com/bolt12/shannon-fano.git $ cd shannon-fano/ $ cabal configure $ cabal build $ cabal install ```++#### Build documentation++```shell+$ cd shannon-fano/+$ cabal haddock+```++### See for yourself  You can see if it's correctly installed by going into ghci and see if you can import the library.

@@ -10,7 +10,7 @@ -- PVP summary:      +-+------- breaking API changes --                   | | +----- non-breaking API additions --                   | | | +--- code changes with no API change-version:             0.1.0.0+version:             0.1.0.1  -- A short (one-line) description of the package. synopsis:            Shannon-fano compression algorithm implementation in Haskell