Update README.md (#1)

- Update README.md (32c07bfd941d82f8c5b4d20952845d65011fffe6)


Co-authored-by: Gabriel Ebner <[email protected]>

README.md

@@ -19,11 +19,11 @@ language:
 # Proof Oriented Programming with AI (PoPAI) - FStarDataSet
 
 This dataset contains programs and proofs in [F* proof-oriented programming language](https://fstar-lang.org/). 
-The data, proposed in [Towards Neural Synthesis for SMT-Assisted Proof-Oriented Programming](https://arxiv.org/pdf/2405.01787).
+The data, proposed in [Towards Neural Synthesis for SMT-Assisted Proof-Oriented Programming](https://arxiv.org/pdf/2405.01787),
 is an archive of source code, build artifacts, and metadata assembled from eight different F⋆-based open source projects on GitHub.
 
 ## Primary-Objective
-This dataset's primary objective is to train and evaluate Proof-oriented Programming with AI (PoPAI, in short). Given a specification of a program and proof is F*, 
+This dataset's primary objective is to train and evaluate Proof-oriented Programming with AI (PoPAI, in short). Given a specification of a program and proof in F*, 
 the objective of a AI model is to synthesize the implemantation (see [below](#usage) for details about the usage of this dataset, including the input and output). 
 
 ## Data Format
@@ -35,27 +35,27 @@ Each of the examples in this dataset are organized as dictionaries with the foll
     "original_source_type": <str: actual source type, to be used for type checking>,
     "source_type": <str: modified source type, to be used to formulate prompt>,
     "source_definition": <str: target definition>,
-    "source": <dict: contains metadata acout the source of this example, including project_name, git url, git sha, etc.>,
+    "source": <dict: contains metadata about the source of this example, including project_name, git url, git sha, etc.>,
     "source_range": <dict: metadata containing start and end lines and columns of this definition in the source file>,
     "file_context": <str: extracted file context upto the point of current definition>, 
     "dependencies": <dict: build dependencies for this file>,
-    "opens_and_abbrevs": <list[dict]: List of opened modules and abbreviated modules in the file, necessry for evaluating.>,
-    "vconfig": <dict: variour buils configuration for this definition>,
-    "interleaved": <bool: whether this definition is interleaved with another>,
+    "opens_and_abbrevs": <list[dict]: List of opened modules and abbreviated modules in the file, necessary for evaluation.>,
+    "vconfig": <dict: SMT solver flags for this definition>,
+    "interleaved": <bool: whether this definition is interleaved from the interface file>,
     "verbose_type": <str: the verbose type of this definition as resolved by the type checker>,
     "effect": <str: effect>,
     "effect_flags": <list[str]: any effect flags>,
-    "mutual_with": <list: if this definition is mutually recursive with other, list of those names>,
+    "mutual_with": <list: if this definition is mutually recursive with another, list of those names>,
     "ideal_premises": <list[str]: Other definitions that are used in the ground truth definition>,
     "proof_features": <list[str]>,
     "is_simple_lemma": <bool/null>,
-    "is_div": <bool: if this definition is divergent>,
+    "is_div": <bool: if this definition has the divergent effect>,
     "is_proof": <bool>,
     "is_simply_typed": <bool>,
     "is_type": <bool/null>,
     "partial_definition": <str>,
     "completed_definiton": <str>,
-    "isa_cross_project_example": <bool: if this example belongs to cross-project evaluation set>
+    "isa_cross_project_example": <bool: if this example belongs to the cross-project evaluation set>
 }
 ```
 
@@ -90,14 +90,14 @@ Download the source code and the `helpers.zip` file from the release.
   
 ## Troubleshooting
 The attached binaries in the evaluator (i.e., `fstar.exe` and `z3`) are built on 
-**`Ubuntu 20.04.6 LTS (GNU/Linux 5.4.0-189-generic x86_64)`**  **`gcc (Ubuntu 9.4.0-1ubuntu1~20.04.2)`**,  **`OCaml 4.12.0`**. 
+**`Ubuntu 20.04.6 LTS (GNU/Linux 5.4.0-189-generic x86_64)`**,  **`gcc (Ubuntu 9.4.0-1ubuntu1~20.04.2)`**,  **`OCaml 4.12.0`**. 
 If any of the binaries do not work properly, build F* from [commit: f3b4db2ebce90020acbbbe1b4ea0d05d3e69ad6c](https://github.com/FStarLang/FStar/commit/f3b4db2ebce90020acbbbe1b4ea0d05d3e69ad6c) 
-from the [F* repository](https://github.com/FStarLang/FStar), using their [installation guide](https://github.com/FStarLang/FStar/blob/master/INSTALL.md).
+from the [F* repository](https://github.com/FStarLang/FStar), using the [installation guide](https://github.com/FStarLang/FStar/blob/master/INSTALL.md).
 
 
 # Data Source
-The raw data in this project are collected from eight open-source F* reposiroties in GitHib 
-1. [FStar](https://github.com/FStarLang/FStar): The F⋆ compiler itself, including its standard libraries and examples.
+The raw data in this project are collected from eight open-source F* repositories on GitHib 
+1. [FStar](https://github.com/FStarLang/FStar): The F⋆ compiler itself, including its standard library and examples.
 2. [Karamel](https://github.com/FStarLang/karamel): A transpiler from a subset of F⋆ called Low* to C, including libraries to work with a model of C types and control structures, e.g., for- and while-loops.
 3. [EverParse](https://github.com/project-everest/everparse): A parser generator for binary formats, used in various large scale systems, e.g., the Windows kernel.
 4. [HACL*](https://github.com/hacl-star/hacl-star): A library of verified cryptographic algorithms, including ValeCrypt, a library of verified assembly code, as well as EverCrypt, a cryptographic provider, including code deployed in Linux, Firefox, and Python.