diff --git a/CHANGES.markdown b/CHANGES.markdown new file mode 100644 --- /dev/null +++ b/CHANGES.markdown @@ -0,0 +1,6 @@ +## Changes in 0 +* This is an intentional empty release. `base-orphans-0` is used when + retroactively adding `base-orphans` dependencies to older Hackage libraries + to ensure that they cannot be built in combination with more recent versions + of `base-orphans` that would cause them to break. (For example, if a package + defines an orphan instance which clashes with one in `base-orphans`.) diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,20 @@ +Copyright (c) 2015 Simon Hengel , João Cristóvão , Ryan Scott + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be included +in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.markdown b/README.markdown new file mode 100644 --- /dev/null +++ b/README.markdown @@ -0,0 +1,60 @@ +# `base-orphans` +[![Hackage](https://img.shields.io/hackage/v/base-orphans.svg)][Hackage: base-orphans] +[![Hackage Dependencies](https://img.shields.io/hackage-deps/v/base-orphans.svg)](http://packdeps.haskellers.com/reverse/base-orphans) +[![Haskell Programming Language](https://img.shields.io/badge/language-Haskell-blue.svg)][Haskell.org] +[![BSD3 License](http://img.shields.io/badge/license-MIT-brightgreen.svg)][tl;dr Legal: MIT] +[![Build](https://img.shields.io/travis/haskell-compat/base-orphans.svg)](https://travis-ci.org/haskell-compat/base-orphans) + +[Hackage: base-orphans]: + http://hackage.haskell.org/package/base-orphans + "base-orphans package on Hackage" +[Haskell.org]: + http://www.haskell.org + "The Haskell Programming Language" +[tl;dr Legal: MIT]: + https://tldrlegal.com/license/mit-license + "MIT License" + +## Scope + +`base-orphans` defines orphan instances that mimic instances available in later +versions of `base` to a wider (older) range of compilers. `base-orphans` does +not export anything except the orphan instances themselves and complements +[base-compat](http://hackage.haskell.org/package/base-compat). + +## About `base-orphans-0` + +`base-orphans-0` is a special release that intentionally does not export any +modules. `base-orphans-0` is used when retroactively adding `base-orphans` +dependencies to older Hackage libraries to ensure that they cannot be built in +combination with more recent versions of `base-orphans` that would cause them +to break. (For example, if a package defines an orphan instance which clashes +with one in `base-orphans`.) + +## Supported versions of GHC/`base` + + * `ghc-8.0.1` / `base-4.9.0.0` + * `ghc-7.10.3` / `base-4.8.2.0` + * `ghc-7.10.2` / `base-4.8.1.0` + * `ghc-7.10.1` / `base-4.8.0.0` + * `ghc-7.8.4` / `base-4.7.0.2` + * `ghc-7.8.3` / `base-4.7.0.1` + * `ghc-7.8.2` / `base-4.7.0.0` + * `ghc-7.8.1` / `base-4.7.0.0` + * `ghc-7.6.3` / `base-4.6.0.1` + * `ghc-7.6.2` / `base-4.6.0.1` + * `ghc-7.6.1` / `base-4.6.0.0` + * `ghc-7.4.2` / `base-4.5.1.0` + * `ghc-7.4.1` / `base-4.5.0.0` + * `ghc-7.2.2` / `base-4.4.1.0` + * `ghc-7.2.1` / `base-4.4.0.0` + * `ghc-7.0.4` / `base-4.3.1.0` + * `ghc-7.0.3` / `base-4.3.1.0` + * `ghc-7.0.2` / `base-4.3.1.0` + * `ghc-7.0.1` / `base-4.3.0.0` + +We also make an attempt to keep `base-orphans` building with GHC HEAD, but due +to its volatility, it may not work at any given point in time. If it doesn't, +please report it! + +Patches are welcome; add tests for new code! diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/base-orphans.cabal b/base-orphans.cabal new file mode 100644 --- /dev/null +++ b/base-orphans.cabal @@ -0,0 +1,37 @@ +-- This file has been generated from package.yaml by hpack version 0.8.0. +-- +-- see: https://github.com/sol/hpack + +name: base-orphans +version: 0 +synopsis: Backwards-compatible orphan instances for base +description: @base-orphans@ defines orphan instances that mimic instances available in later versions of @base@ to a wider (older) range of compilers. @base-orphans@ does not export anything except the orphan instances themselves and complements @@. + `base-orphans-0` is an intentional empty release. For an explanation as to why it exists, see the . +category: Compatibility +homepage: https://github.com/haskell-compat/base-orphans#readme +bug-reports: https://github.com/haskell-compat/base-orphans/issues +author: Simon Hengel , + João Cristóvão , + Ryan Scott +maintainer: Simon Hengel , + João Cristóvão , + Ryan Scott +copyright: (c) 2012-2015 Simon Hengel, + (c) 2014 João Cristóvão, + (c) 2015 Ryan Scott +license: MIT +license-file: LICENSE +build-type: Simple +cabal-version: >= 1.10 + +extra-source-files: + CHANGES.markdown + README.markdown + +source-repository head + type: git + location: https://github.com/haskell-compat/base-orphans + +library + ghc-options: -Wall + default-language: Haskell2010