chore: add READMEs to cabal files

blackheaven · blackheaven · commit b1863e27bb63 · 2025-07-20T14:46:54.000+02:00
diff --git a/code/cvss/README.md b/code/cvss/README.md
@@ -0,0 +1,7 @@
+# cvss
+
+This project aims to support [Common Vulnerability Scoring System](https://www.first.org/cvss/).
+
+## Building
+
+We aim to support both regular cabal-based and nix-based builds.
diff --git a/code/cvss/cvss.cabal b/code/cvss/cvss.cabal
@@ -9,7 +9,7 @@ license:         BSD-3-Clause
 author:          Tristan de Cacqueray
 maintainer:      tdecacqu@redhat.com
 category:        Data
-extra-doc-files: CHANGELOG.md
+extra-doc-files: CHANGELOG.md, README.md
 tested-with:
   GHC ==8.10.7 || ==9.0.2 || ==9.2.8 || ==9.4.8 || ==9.6.6 || ==9.8.3 || ==9.10.1 || ==9.12.1
 
diff --git a/code/hsec-core/hsec-core.cabal b/code/hsec-core/hsec-core.cabal
@@ -19,7 +19,7 @@ maintainer:         security-advisories@haskell.org
 -- A copyright notice.
 -- copyright:
 category:           Data
-extra-doc-files:    CHANGELOG.md
+extra-doc-files:    CHANGELOG.md, README.md
 
 tested-with:
   GHC ==8.10.7 || ==9.0.2 || ==9.2.8 || ==9.4.8 || ==9.6.6 || ==9.8.3 || ==9.10.1 || ==9.12.1
diff --git a/code/hsec-sync/hsec-sync.cabal b/code/hsec-sync/hsec-sync.cabal
@@ -19,7 +19,7 @@ maintainer:      gautier.difolco@gmail.com
 -- A copyright notice.
 -- copyright:
 category:        Data
-extra-doc-files: CHANGELOG.md, overview.png, recommended-workflow.png
+extra-doc-files: CHANGELOG.md, overview.png, recommended-workflow.png, README.md
 tested-with:
   GHC ==8.10.7 || ==9.0.2 || ==9.2.8 || ==9.4.8 || ==9.6.6 || ==9.8.3 || ==9.10.1 || ==9.12.1
 
diff --git a/code/hsec-tools/hsec-tools.cabal b/code/hsec-tools/hsec-tools.cabal
@@ -21,7 +21,7 @@ maintainer:         security-advisories@haskell.org
 -- A copyright notice.
 -- copyright:
 category:           Data
-extra-doc-files:    CHANGELOG.md
+extra-doc-files:    CHANGELOG.md, README.md
 extra-source-files:
   assets/css/*.css
   assets/images/*.png
diff --git a/code/osv/osv.cabal b/code/osv/osv.cabal
@@ -21,7 +21,7 @@ maintainer:         security-advisories@haskell.org
 -- A copyright notice.
 -- copyright:
 category:           Data
-extra-doc-files:    CHANGELOG.md
+extra-doc-files:    CHANGELOG.md, README.md
 
 tested-with:
   GHC ==8.10.7 || ==9.0.2 || ==9.2.8 || ==9.4.8 || ==9.6.6 || ==9.8.3 || ==9.10.1 || ==9.12.1
diff --git a/code/purl/purl.cabal b/code/purl/purl.cabal
@@ -9,7 +9,7 @@ license:         BSD-3-Clause
 author:          Gautier DI FOLCO
 maintainer:      foss@difolco.dev
 category:        Data
-extra-doc-files: CHANGELOG.md
+extra-doc-files: CHANGELOG.md, README.md
 tested-with:
   GHC ==8.10.7 || ==9.0.2 || ==9.2.8 || ==9.4.8 || ==9.6.6 || ==9.8.3 || ==9.10.1 || ==9.12.1
 
