Update README.md (installation); Fix copyright notice
parent
83ba7803e6
commit
296629b96c
46
README.md
46
README.md
|
@ -48,33 +48,35 @@ linear in the size of the input (although the constant factor is not small).
|
|||
comments are moved slightly; there are also cases where comments result in
|
||||
wonky newline insertion (although this should be a purely aesthetic issue.)
|
||||
|
||||
# Building
|
||||
# Installation
|
||||
|
||||
(This does not cover _installation_. TODO)
|
||||
- via `cabal` "old-build"
|
||||
|
||||
via `cabal new-build`
|
||||
~~~~.sh
|
||||
git clone https://github.com/lspitzner/brittany.git
|
||||
cd brittany
|
||||
cabal sandbox init
|
||||
cabal install --bindir=$HOME/.cabal/bin # -w $PATH_TO_GHC_8
|
||||
~~~~
|
||||
|
||||
~~~~.sh
|
||||
mkdir brittany-project
|
||||
cd brittany-project/
|
||||
git clone https://github.com/lspitzner/butcher.git
|
||||
git clone https://github.com/lspitzner/data-tree-print.git
|
||||
git clone https://github.com/lspitzner/ghc-exactprint.git
|
||||
git clone https://github.com/lspitzner/brittany.git
|
||||
cat > cabal.project <<EOF
|
||||
packages: data-tree-print butcher ghc-exactprint brittany
|
||||
EOF
|
||||
# cabal new-configure -w $PATH_TO_GHC_8
|
||||
cabal new-build brittany/
|
||||
~~~~
|
||||
- via `cabal new-build`
|
||||
|
||||
or via `stack`
|
||||
~~~~.sh
|
||||
git clone https://github.com/lspitzner/brittany.git
|
||||
cd brittany
|
||||
# cabal new-configure -w $PATH_TO_GHC_8
|
||||
cabal new-build brittany
|
||||
# and it should be safe to just copy the executable, e.g.
|
||||
cp ./dist-newstyle/build/brittany-0.8.0.0/build/brittany/brittany $HOME/.cabal/bin/
|
||||
~~~~
|
||||
|
||||
~~~~.sh
|
||||
git clone https://github.com/lspitzner/brittany.git
|
||||
cd brittany
|
||||
stack build
|
||||
~~~~
|
||||
- via `stack`
|
||||
|
||||
~~~~.sh
|
||||
git clone https://github.com/lspitzner/brittany.git
|
||||
cd brittany
|
||||
stack install
|
||||
~~~~
|
||||
|
||||
|
||||
# Usage
|
||||
|
|
|
@ -12,7 +12,7 @@ license: AllRightsReserved
|
|||
-- license-file: LICENSE
|
||||
author: Lennart Spitzner
|
||||
maintainer: lsp@informatik.uni-kiel.de
|
||||
-- copyright:
|
||||
copyright: Copyright (C) 2016-2017 Lennart Spitzner
|
||||
category: Language
|
||||
build-type: Simple
|
||||
extra-source-files: ChangeLog.md
|
||||
|
@ -20,6 +20,11 @@ cabal-version: >=1.10
|
|||
homepage: https://github.com/lspitzner/brittany/
|
||||
bug-reports: https://github.com/lspitzner/brittany/issues
|
||||
|
||||
source-repository head {
|
||||
type: git
|
||||
location: https://github.com/lspitzner/brittany.git
|
||||
}
|
||||
|
||||
flag brittany-dev
|
||||
description: dev options
|
||||
default: False
|
||||
|
|
|
@ -80,7 +80,7 @@ mainCmdParser helpDesc = do
|
|||
when printVersion $ do
|
||||
liftIO $ do
|
||||
putStrLn $ "brittany version " ++ showVersion version
|
||||
putStrLn $ "Copyright (C) 2016 Lennart Spitzner"
|
||||
putStrLn $ "Copyright (C) 2016-2017 Lennart Spitzner"
|
||||
putStrLn $ "There is NO WARRANTY, to the extent permitted by law."
|
||||
System.Exit.exitSuccess
|
||||
when printHelp $ do
|
||||
|
|
Loading…
Reference in New Issue