Standards

LIBRARIES.md

@@ -0,0 +1,45 @@
+# Libraries we use
+
+We describe the correct library (or libraries) to use for common tasks, and the
+ones we choose to use in our project. Other libraries can be considered on a
+case-by-case basis.
+
+# Benchmarks
+
+* `tasty-bench`
+
+# Data structures
+
+* `acc`
+* `bytestring`
+* `containers`
+* `vector`
+
+# Effects
+
+* `mtl`
+* `transformers`
+
+# JSON
+
+* `aeson` (sigh)
+
+# Optics
+
+* `optics-core`
+* `optics-extra`
+
+# Prettyprinting
+
+* `prettyprinter`
+
+# Testing
+
+* `QuickCheck`
+* `quickcheck-classes`
+* `quickcheck-instances`
+* `tasty`
+* `tasty-expected-failure`
+* `tasty-hunit`
+* `tasty-laws`
+* `tasty-quickcheck`

README.md

@@ -1,2 +1,28 @@
-# covenant
-IR for Cardano scripts
+# Covenant
+
+# What is this?
+
+# How do I use this?
+
+# What do I need?
+
+Our policy is to support the latest three GHC versions. At this time, they are:
+
+* 9.6.6
+* 9.8.4
+* 9.10.1
+
+Covenant is developed using the lowest version listed exclusively, but
+compatibility with higher versions listed above is assured by our CI. We support
+only [Tier 1
+platforms](https://gitlab.haskell.org/ghc/ghc/-/wikis/platforms#tier-1-platforms).
+
+# License
+
+Covenant is licensed under Apache 2.0. Please see the `LICENSE` file for more
+information. 
+
+# References
+
+* [Catalyst proposal for
+  Covenant](https://projectcatalyst.io/funds/13/f13-cardano-open-developers/mlabs-static-analysis-with-covenant)