Update README.md

README.md

@@ -1,3 +1,64 @@
----
-license: lgpl-2.1
----
+---
+language: 
+  - "en"
+pretty_name: "Coq Changelog Dataset"
+tags:
+  - "theorem-proving"
+  - "formal-methods"
+  - "coq"
+  - "changelog"
+  - "version-control"
+license: "lgpl-2.1"
+task_categories:
+  - "text-generation"
+  - "feature-extraction"
+  - "other"
+---
+
+# Coq Changelog Dataset
+
+## Dataset Description
+
+The Coq Changelog Dataset is derived from the official Coq changelogs, focusing on versions 8.17 to 8.20. These versions were specifically chosen as they represent changes that may be underrepresented or entirely absent from current language model training data. By targeting these recent versions, this dataset helps address knowledge gaps in formal methods tools and theorem proving systems.
+
+This dataset provides structured, machine-readable entries for changes in Coq, including additions, fixes, deprecations, and removals, with a focus on practical updates likely to impact users or developers.
+
+### Dataset Structure
+
+The dataset includes the following fields:
+- version: The Coq version associated with the change (e.g., "8.20.0").
+- category: The category of the change (e.g., "Kernel," "Tactics," "Notations").
+- type: The type of change (e.g., "Added," "Fixed," "Changed," "Deprecated," "Removed").
+- change: The actual modification description (excluding references and author details).
+- change_number: A list of all referenced change numbers (e.g., ["12345", "67890"]).
+
+### Example Row
+
+{
+  "version": "8.20.0",
+  "category": "Kernel",
+  "type": "Changed",
+  "change": "The guard checker now recognizes uniform parameters of a fixpoint and treats their instances as constant over the recursive call",
+  "change_number": ["17986", "16040"]
+}
+
+### Source Code
+
+The dataset was created by processing the official Coq changelogs to extract and structure their content into individual, machine-readable entries. While the changelogs cover Coq's entire history, only changes from versions 8.17 through 8.20 are included here. This selection reflects the likelihood that older versions are already well-represented in language models, while recent updates are more prone to omission. Parenthetical references (e.g., "#12345," "fixes #67890") were parsed into the change_number field for indexing and analysis, while the change field retains a clean, descriptive summary of the update.
+
+### Usage
+
+This dataset is designed for:
+- Formal Methods Research: Understanding the evolution of Coq features and their impact on proof strategies.
+- Machine Learning Applications: Training models for Coq version prediction, changelog summarization, or toolchain adaptation.
+- Educational Purposes: Teaching Coq users about recent changes or deprecated features in new releases.
+
+### License
+
+This dataset is distributed under the LGPL-2.1 license, aligning with the licensing of the Coq project.
+
+### Acknowledgments
+
+- Official Coq Repository: https://github.com/coq/coq  
+- Dataset Maintainer: phanerozoic  
+- Inspired by: Andreas Florath's Coq Facts, Propositions, and Proofs Dataset