gnatprove 14.1.1 metadata (#1444)

Add an author, website, and long description that provides links for getting started with GNATprove
2025-03-20 14:05:53 -04:00
parent f189c45bd9
commit d1fe9756c8
1 changed files with 25 additions and 1 deletions
@@ -1,9 +1,33 @@
 name = "gnatprove"
 version = "14.1.1"
+authors = ["AdaCore"]
 description = "Automatic formal verification of SPARK code"
-maintainers = ["chouteau@adacore.com"]
+maintainers = ["Fabien Chouteau <chouteau@adacore.com>"]
 maintainers-logins = ["Fabien-Chouteau"]
 licenses = "GPL-3.0-or-later"
+website = "https://docs.adacore.com/spark2014-docs/html/ug/index.html"
+
+long-description = """
+GNATprove, which provides automatic formal verification of SPARK code, is based on the [open-source](https://github.com/AdaCore/spark2014) [SPARK Pro](https://www.adacore.com/sparkpro) by [AdaCore](https://www.adacore.com).
+The [SPARK Pro User's Guide](https://docs.adacore.com/spark2014-docs/html/ug/index.html) provides extensive documentation on how to use GNATprove.
+Note that because this version of GNATprove is built from an intermediate commit of SPARK Pro, it is not representative of any specific SPARK Pro release, and the SPARK Pro documentation may describe features or capabilities that are not yet available in this version of GNATprove.
+
+To use GNATprove, simply add it to your Alire project using
+
+    alr with gnatprove
+
+Then, configure your environment by running:
+
+    eval "$( alr printenv )"
+
+You will then be able to run GNATprove:
+
+    gnatprove
+
+For more details on getting started using GNATprove, see [Getting Started with SPARK](https://docs.adacore.com/spark2014-docs/html/ug/en/getting_started.html) from the [SPARK Pro User's Guide](https://docs.adacore.com/spark2014-docs/html/ug/index.html).
+
+To get started with the SPARK language, see the [Introduction to SPARK](https://learn.adacore.com/courses/intro-to-spark/index.html) course on [learn.adacore.com](https://learn.adacore.com/index.html).
+"""

 auto-gpr-with = false