Merge pull request #20 from AU-COBRA/docs

Add changelog and readme

CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2024-07-10
+Initial release
+
+Compatible with Coq 8.17-8.19
+
+[unreleased]: https://github.com/AU-COBRA/coq-elm-extraction/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/AU-COBRA/coq-elm-extraction/releases/tag/v0.1.0

README.md

@@ -1,3 +1,51 @@
-# coq-elm-extraction
+# Coq Elm Extraction
+[![Build](https://github.com/AU-COBRA/coq-elm-extraction/actions/workflows/build.yml/badge.svg)](https://github.com/AU-COBRA/coq-elm-extraction/actions/workflows/build.yml)
+[![GitHub](https://img.shields.io/github/license/AU-COBRA/coq-elm-extraction)](https://github.com/AU-COBRA/coq-elm-extraction/blob/master/LICENSE)
+[![Documentation](https://img.shields.io/github/deployments/au-cobra/coq-elm-extraction/github-pages?label=docs)](https://au-cobra.github.io/coq-elm-extraction/)
 
-For documentation see [ConCert](https://github.com/AU-COBRA/ConCert)
+
+A framework for extracting Coq programs to Elm.
+
+## Meta
+
+- Author(s):
+  - Danil Annenkov (initial)
+  - Mikkel Milo (initial)
+  - Jakob Botsch Nielsen (initial)
+  - Bas Spitters (initial)
+  - Eske Hoy Nielsen
+- License: [MIT](LICENSE)
+- Compatible Coq versions: 8.17 or later
+- Additional dependencies: MetaCoq
+- Coq namespace: `ElmExtraction`
+- Related publication(s):
+  - [Extracting functional programs from Coq, in Coq](https://arxiv.org/abs/2108.02995) doi:[10.1017/S0956796822000077](https://doi.org/10.1017/S0956796822000077)
+  - ["Extending MetaCoq Erasure: Extraction to Rust and Elm"](https://dannenkov.me/papers/extraction-rust-elm-coq-workshop2021.pdf)
+  - ["Extracting Smart Contracts Tested and Verified in Coq"](https://arxiv.org/abs/2012.09138) doi:[10.1145/3437992.3439934](https://doi.org/10.1145/3437992.3439934)
+
+
+## Building and installation instructions
+
+The easiest way to install the latest released version is via [OPAM](https://opam.ocaml.org/doc/Install.html):
+
+```shell
+opam repo add coq-released https://coq.inria.fr/opam/released
+opam install coq-elm-extraction
+```
+
+To instead build and install manually, do:
+
+```shell
+opam repo add coq-released https://coq.inria.fr/opam/released
+git clone https://github.com/AU-COBRA/coq-elm-extraction.git
+cd coq-elm-extraction
+opam install . --deps-only
+make #or make -j <number-of-cores-on-your-machine> 
+make install
+```
+
+## Documentation
+
+For documentation see [examples](/tests/theories/) and [generated CoqDoc](https://au-cobra.github.io/coq-elm-extraction/).
+
+Additional examples can be found in [ConCert](https://github.com/AU-COBRA/ConCert).