ehmry/dhall-haskell
ehmry
/
dhall-haskell
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
dhall-haskell/README.md

36 lines
1.0 KiB
Markdown
Raw Normal View History

Migrate `dhall-{bash,json,text}` into this repository (#661) The motivation for this change is: * To catch build failures in downstream packages whenever we make a breaking change to the `dhall` API * To reduce the amount of work I need in order to cut a release for all of these packages * To better share Nix/CI-related logic between the projects Note that I have not yet migrated `dhall-nix` in. I'm waiting for https://github.com/dhall-lang/dhall-nix/issues/17 to be fixed since `dhall-nix` is incompatible with later versions of `megaparsec` due to `hnix`.
2018-10-29 01:32:51 +01:00
# `dhall-haskell`
Add `README.md`
2016-12-05 05:04:50 +01:00
Migrate `dhall-{bash,json,text}` into this repository (#661) The motivation for this change is: * To catch build failures in downstream packages whenever we make a breaking change to the `dhall` API * To reduce the amount of work I need in order to cut a release for all of these packages * To better share Nix/CI-related logic between the projects Note that I have not yet migrated `dhall-nix` in. I'm waiting for https://github.com/dhall-lang/dhall-nix/issues/17 to be fixed since `dhall-nix` is incompatible with later versions of `megaparsec` due to `hnix`.
2018-10-29 01:32:51 +01:00
This repository is a shared repository for all of the `dhall-*` Haskell
packages, including:
Add `README.md`
2016-12-05 05:04:50 +01:00
Migrate `dhall-{bash,json,text}` into this repository (#661) The motivation for this change is: * To catch build failures in downstream packages whenever we make a breaking change to the `dhall` API * To reduce the amount of work I need in order to cut a release for all of these packages * To better share Nix/CI-related logic between the projects Note that I have not yet migrated `dhall-nix` in. I'm waiting for https://github.com/dhall-lang/dhall-nix/issues/17 to be fixed since `dhall-nix` is incompatible with later versions of `megaparsec` due to `hnix`.
2018-10-29 01:32:51 +01:00
* [`dhall`](./dhall)
* [`dhall-bash`](./dhall-bash)
* [`dhall-json`](./dhall-json)
* [`dhall-text`](./dhall-text)
Add `README.md`
2016-12-05 05:04:50 +01:00
Migrate `dhall-{bash,json,text}` into this repository (#661) The motivation for this change is: * To catch build failures in downstream packages whenever we make a breaking change to the `dhall` API * To reduce the amount of work I need in order to cut a release for all of these packages * To better share Nix/CI-related logic between the projects Note that I have not yet migrated `dhall-nix` in. I'm waiting for https://github.com/dhall-lang/dhall-nix/issues/17 to be fixed since `dhall-nix` is incompatible with later versions of `megaparsec` due to `hnix`.
2018-10-29 01:32:51 +01:00
Navigate to each package's directory for their respective `README`s
Update `README` and Nix logic (#650) Fixes https://github.com/dhall-lang/dhall-haskell/issues/645 Fixes https://github.com/dhall-lang/dhall-lang/issues/216 This updates the `README` with the following changes: * Points to the language-agnostic `README` in the `dhall-lang` repository * Retains only Haskell-specific sections of interest * Removes the embedded LICENSE now that GitHub auto-recognizes the project license (#644) * Changes the Quick Start instructions to use Nix * Adds instructions for project development using Nix The latter two points entailed refactors to the Nix logic to simplify the user experience: * `default.nix` was moved to `shared.nix` and replaced with a new `default.nix` that works out-of-the-box with `nix-build` * There is a new `nix/test-dhall.nix` which users can use to create a `nix-shell` with Dhall as a dependency
2018-10-20 18:27:16 +02:00
Migrate `dhall-{bash,json,text}` into this repository (#661) The motivation for this change is: * To catch build failures in downstream packages whenever we make a breaking change to the `dhall` API * To reduce the amount of work I need in order to cut a release for all of these packages * To better share Nix/CI-related logic between the projects Note that I have not yet migrated `dhall-nix` in. I'm waiting for https://github.com/dhall-lang/dhall-nix/issues/17 to be fixed since `dhall-nix` is incompatible with later versions of `megaparsec` due to `hnix`.
2018-10-29 01:32:51 +01:00
# Quick start
Update `README` and Nix logic (#650) Fixes https://github.com/dhall-lang/dhall-haskell/issues/645 Fixes https://github.com/dhall-lang/dhall-lang/issues/216 This updates the `README` with the following changes: * Points to the language-agnostic `README` in the `dhall-lang` repository * Retains only Haskell-specific sections of interest * Removes the embedded LICENSE now that GitHub auto-recognizes the project license (#644) * Changes the Quick Start instructions to use Nix * Adds instructions for project development using Nix The latter two points entailed refactors to the Nix logic to simplify the user experience: * `default.nix` was moved to `shared.nix` and replaced with a new `default.nix` that works out-of-the-box with `nix-build` * There is a new `nix/test-dhall.nix` which users can use to create a `nix-shell` with Dhall as a dependency
2018-10-20 18:27:16 +02:00
Migrate `dhall-{bash,json,text}` into this repository (#661) The motivation for this change is: * To catch build failures in downstream packages whenever we make a breaking change to the `dhall` API * To reduce the amount of work I need in order to cut a release for all of these packages * To better share Nix/CI-related logic between the projects Note that I have not yet migrated `dhall-nix` in. I'm waiting for https://github.com/dhall-lang/dhall-nix/issues/17 to be fixed since `dhall-nix` is incompatible with later versions of `megaparsec` due to `hnix`.
2018-10-29 01:32:51 +01:00
You can build all of the packages by running:
Update `README` and Nix logic (#650) Fixes https://github.com/dhall-lang/dhall-haskell/issues/645 Fixes https://github.com/dhall-lang/dhall-lang/issues/216 This updates the `README` with the following changes: * Points to the language-agnostic `README` in the `dhall-lang` repository * Retains only Haskell-specific sections of interest * Removes the embedded LICENSE now that GitHub auto-recognizes the project license (#644) * Changes the Quick Start instructions to use Nix * Adds instructions for project development using Nix The latter two points entailed refactors to the Nix logic to simplify the user experience: * `default.nix` was moved to `shared.nix` and replaced with a new `default.nix` that works out-of-the-box with `nix-build` * There is a new `nix/test-dhall.nix` which users can use to create a `nix-shell` with Dhall as a dependency
2018-10-20 18:27:16 +02:00
Add `README.md`
2016-12-05 05:04:50 +01:00
```
Update `README` and Nix logic (#650) Fixes https://github.com/dhall-lang/dhall-haskell/issues/645 Fixes https://github.com/dhall-lang/dhall-lang/issues/216 This updates the `README` with the following changes: * Points to the language-agnostic `README` in the `dhall-lang` repository * Retains only Haskell-specific sections of interest * Removes the embedded LICENSE now that GitHub auto-recognizes the project license (#644) * Changes the Quick Start instructions to use Nix * Adds instructions for project development using Nix The latter two points entailed refactors to the Nix logic to simplify the user experience: * `default.nix` was moved to `shared.nix` and replaced with a new `default.nix` that works out-of-the-box with `nix-build` * There is a new `nix/test-dhall.nix` which users can use to create a `nix-shell` with Dhall as a dependency
2018-10-20 18:27:16 +02:00
$ nix-build
```
Add `README.md`
2016-12-05 05:04:50 +01:00
Migrate `dhall-{bash,json,text}` into this repository (#661) The motivation for this change is: * To catch build failures in downstream packages whenever we make a breaking change to the `dhall` API * To reduce the amount of work I need in order to cut a release for all of these packages * To better share Nix/CI-related logic between the projects Note that I have not yet migrated `dhall-nix` in. I'm waiting for https://github.com/dhall-lang/dhall-nix/issues/17 to be fixed since `dhall-nix` is incompatible with later versions of `megaparsec` due to `hnix`.
2018-10-29 01:32:51 +01:00
... or you can run `nix-build` within each package's respective directory to
build just that one package.
Add `README.md`
2016-12-05 05:04:50 +01:00
## Development status
Fix Travis badge in README (#169) Seems to be pointing at an old location of this repository, I have updated it to point at the current location.
2017-10-27 11:01:33 +02:00
[![Build Status](https://travis-ci.org/dhall-lang/dhall-haskell.png)](https://travis-ci.org/dhall-lang/dhall-haskell)
Add `README.md`
2016-12-05 05:04:50 +01:00
The compiler is built upon a theoretically sound foundation, meaning that if
there are no bugs then the language will never crash and will always halt.
However, in practice the compiler needs to be battle-tested to weed out any
Update `README` and Nix logic (#650) Fixes https://github.com/dhall-lang/dhall-haskell/issues/645 Fixes https://github.com/dhall-lang/dhall-lang/issues/216 This updates the `README` with the following changes: * Points to the language-agnostic `README` in the `dhall-lang` repository * Retains only Haskell-specific sections of interest * Removes the embedded LICENSE now that GitHub auto-recognizes the project license (#644) * Changes the Quick Start instructions to use Nix * Adds instructions for project development using Nix The latter two points entailed refactors to the Nix logic to simplify the user experience: * `default.nix` was moved to `shared.nix` and replaced with a new `default.nix` that works out-of-the-box with `nix-build` * There is a new `nix/test-dhall.nix` which users can use to create a `nix-shell` with Dhall as a dependency
2018-10-20 18:27:16 +02:00
implementation bugs, so please open issues! 🙂
Read the following guide if you would like to contribute:
* [Contributing to Dhall](https://github.com/dhall-lang/dhall-lang/blob/master/.github/CONTRIBUTING.md)