Skip to content
Snippets Groups Projects
Commit 868ac64b authored by Virgile Prevosto's avatar Virgile Prevosto
Browse files

[README] update for 24.0

- use https for URL
- fix URL of frama-c-discuss
- update quick install instructions for opam 2.1.0
- use --dev-repo for opam pin instructions
parent a536e847
No related branches found
No related tags found
No related merge requests found
![Frama-C](share/frama-c.png?raw=true) ![Frama-C](share/frama-c.png?raw=true)
[Frama-C](http://frama-c.com) is a platform dedicated to the analysis of [Frama-C](https://frama-c.com) is a platform dedicated to the analysis of
source code written in C. source code written in C.
## A Collaborative Platform ## A Collaborative Platform
...@@ -23,14 +23,18 @@ Thanks to this approach, Frama-C provides sophisticated tools, including: ...@@ -23,14 +23,18 @@ Thanks to this approach, Frama-C provides sophisticated tools, including:
(**From**, **Impact**, **Metrics**, **Occurrence**, **Scope**, etc.). (**From**, **Impact**, **Metrics**, **Occurrence**, **Scope**, etc.).
These plug-ins share a common language and can exchange information via These plug-ins share a common language and can exchange information via
**[ACSL](http://frama-c.com/acsl.html)** (*ANSI/ISO C Specification Language*) **[ACSL](https://frama-c.com/acsl.html)** (*ANSI/ISO C Specification Language*)
properties. Plug-ins can also collaborate via their APIs. properties. Plug-ins can also collaborate via their APIs.
## Installation ## Installation
Frama-C is available through [opam](http://opam.ocaml.org/), the Frama-C is available through [opam](https://opam.ocaml.org/), the
OCaml package manager. If you have it, simply run: OCaml package manager. If you have it, simply run:
opam install frama-c
or, for `opam` versions less than 2.1.0:
opam install depext # handles external (non-OCaml) dependencies opam install depext # handles external (non-OCaml) dependencies
opam depext frama-c --install opam depext frama-c --install
...@@ -45,7 +49,7 @@ see [INSTALL.md](INSTALL.md). ...@@ -45,7 +49,7 @@ see [INSTALL.md](INSTALL.md).
To install the development branch of Frama-C (updated nightly): To install the development branch of Frama-C (updated nightly):
opam pin add frama-c https://git.frama-c.com/frama-c#master opam pin add frama-c --dev-repo
This command will *pin* the development version of Frama-C and try to install it. This command will *pin* the development version of Frama-C and try to install it.
If installation fails due to missing external dependencies, try using If installation fails due to missing external dependencies, try using
...@@ -78,7 +82,7 @@ To list all plug-ins, run: ...@@ -78,7 +82,7 @@ To list all plug-ins, run:
frama-c -plugins frama-c -plugins
Each plug-in has a help command Each plug-in has a help command
(`-<plugin>-help` or `-<plugin>-h`) that describes its several (`-<plugin>-help` or `-<plugin>-h`) that describes its own
options. options.
Finally, the list of options governing the behavior of Frama-C's kernel itself Finally, the list of options governing the behavior of Frama-C's kernel itself
...@@ -109,13 +113,13 @@ via the GUI: ...@@ -109,13 +113,13 @@ via the GUI:
## Further reference ## Further reference
- Links to user and developer manuals, Frama-C archives, - Links to user and developer manuals, Frama-C archives,
and plug-in manuals are available at <br> http://frama-c.com/html/get-frama-c.html and plug-in manuals are available at <br> https://frama-c.com/html/get-frama-c.html
- [StackOverflow](http://stackoverflow.com/questions/tagged/frama-c) has several - [StackOverflow](https://stackoverflow.com/questions/tagged/frama-c) has several
questions with the `frama-c` tag, which is monitored by several members of the questions with the `frama-c` tag, which is monitored by several members of the
Frama-C community. Frama-C community.
- The [Frama-c-discuss mailing list](http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/frama-c-discuss) - The [Frama-c-discuss mailing list](https://groupes.renater.fr/sympa/info/frama-c-discuss)
is used for announcements and general discussions. is used for announcements and general discussions.
- The [Frama-C public repository](https://git.frama-c.com/pub/frama-c) - The [Frama-C public repository](https://git.frama-c.com/pub/frama-c)
...@@ -127,6 +131,6 @@ via the GUI: ...@@ -127,6 +131,6 @@ via the GUI:
contains links to all manuals and plugins description, as well as tutorials, courses contains links to all manuals and plugins description, as well as tutorials, courses
and more. and more.
- The [Frama-C blog](http://frama-c.com/blog) has several posts about - The [Frama-C blog](https://frama-c.com/blog) has several posts about
new developments of Frama-C, as well as general discussions about the C new developments of Frama-C, as well as general discussions about the C
language, undefined behavior, floating-point computations, etc. language, undefined behavior, floating-point computations, etc.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment