esop artifact requirements

DOCKER.md

@@ -1,7 +1,7 @@
 
 # Build Docker Image
 
-A docker image can be built and generated via
+A docker image is provided with the artifact. It can be built and generated again via
 ```
 docker build -t formalization .
 docker save formalization > formalization-docker.tar

INSTALL

@@ -0,0 +1,6 @@
+
+Once Coq is properly setup (see REQUIREMENTS.md), you can simply issue `make` in the root folder and browse the proof with your favourite Coq IDE.
+
+Alternatively, instructions for using a docker container are provided in DOCKER.md.
+
+For easiness, the html documentation built using `coqdoc` is included in the artefact. It can be built again invoking `make coqdoc`.

LICENSE

@@ -0,0 +1,7 @@
+Copyright © 2024 <anonymous authors>
+
+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.

REQUIREMENTS.md

@@ -0,0 +1,13 @@
+
+# Software Requirements
+
+The project builds with Coq version `8.16.1`. It depends on the opam package `coq-smpl` and `coq-equations` (version 1.3 at least). After setting up [opam](https://opam.ocaml.org/doc/Usage.html), the proper environment is installed with
+```
+opam install coq.8.16.1 coq-equations.1.3+8.16 coq-smpl.8.16
+```
+
+Alternatively, a `Dockerfile` is provided for [docker](https://docs.docker.com/) image setup.
+
+# Hardware Requirements
+
+The projects takes several minutes to compile on a recent laptop (4GHz processor, 8GB RAM). Less than 2GB of RAM is not recommended.

STATUS

@@ -0,0 +1,11 @@
+
+The authors are applying for the following badges:
+
+- Available
+The artifact is published through Zenodo. The DOI will be included in the camera-ready version of the paper. A git repository will be made publicly available as well once anonymity has been lifted.
+
+- Functional
+The artifact is complete. It can be checked and browsed with the Coq proof assistant.
+
+- Reusable
+We believe the artifact is build on solid grounds, namely Martin-Löf à la Coq (to be presented at CPP 2024). We beleive it is possible to rely on our development to extend further the formalization (e.g. to subtyping, as suggested in future work).