documentation.html 4.39 KB
Newer Older
Allan Blanchard's avatar
Allan Blanchard committed
1
2
3
4
---
css: documentation
layout: default
title: Documentation - Frama-C
Allan Blanchard's avatar
Allan Blanchard committed
5
description: Quick access to the documentation of Frama-C and the plugins developed by the Frama-C team.
Allan Blanchard's avatar
Allan Blanchard committed
6
---
Augustin Lemesle's avatar
Augustin Lemesle committed
7

Augustin Lemesle's avatar
Augustin Lemesle committed
8
<body class="page nonTouch">
Augustin Lemesle's avatar
Augustin Lemesle committed
9
10

  <div id="wrapper" class="hfeed">
Allan Blanchard's avatar
Allan Blanchard committed
11

12
    {% include headers.html header="documentation" %}
Augustin Lemesle's avatar
Augustin Lemesle committed
13
14
15
16
17

    <div id="container" class="mainContainer">
      <div class="pageDocumentation pages">
        <div class="wrap">
          <h1 class="pageTitle">Documentation</h1>
18
          <div class="tileWrapper" size="small">
Allan Blanchard's avatar
Allan Blanchard committed
19
20
21
22
23
24
25
            <div class="tileWrapperTitle">
              <span>Frama-C and ACSL</span>
            </div>
            <div class="tile">
              <h4 class="tileTitle"><span>Frama-C</span></h4>
              <ul>
                <li><a href="/html/kernel.html">Description page</a></li>
26
                <li><a href="/download/frama-c-user-manual.pdf">User manual</a></li>
Allan Blanchard's avatar
Allan Blanchard committed
27
28
                <li><a href="https://git.frama-c.com/pub/frama-c/blob/master/INSTALL.md">Installation</a></li>
                <li><a href="/html/get-frama-c.html">Releases</a></li>
Augustin Lemesle's avatar
Augustin Lemesle committed
29
                <!-- <li><a href="/html/publications.html">List of publications</a></li> -->
30
31
                <li><a href="/html/tutorials.html">Tutorials</a></li>
                <li><a href="/html/teaching.html">Teaching</a></li>
Allan Blanchard's avatar
Allan Blanchard committed
32
33
              </ul>
            </div>
34
35
36
37
            <div class="tile">
              <h4 class="tileTitle"><span>ACSL</span></h4>
              <ul>
                <li><a href="/html/acsl.html">Description page</a></li>
38
39
40
                <li><a href="/download/acsl.pdf">Language reference</a></li>
                <li><a href="/download/frama-c-acsl-implementation.pdf">Language implementation</a></li>
                <li><a href="https://github.com/acsl-language/acsl">ACSL Git repository</a></li>
Allan Blanchard's avatar
Allan Blanchard committed
41
                <li><a href="https://github.com/fraunhoferfokus/acsl-by-example/blob/master/ACSL-by-Example.pdf">ACSL by Example</a></li>
42
43
              </ul>
            </div>
Allan Blanchard's avatar
Allan Blanchard committed
44
45
46
            <div class="tile">
              <h4 class="tileTitle"><span>Contributing</span></h4>
              <ul>
47
48
                <li><a href="https://git.frama-c.com/pub/frama-c/">Frama-C Git repository</a></li>
                <li><a href="https://git.frama-c.com/pub/pub.frama-c.com/">Website Git repository</a></li>
49
                <li><a href="https://git.frama-c.com/pub/frama-c/blob/master/CONTRIBUTING.md">Contributer guide</a></li>
Allan Blanchard's avatar
Allan Blanchard committed
50
                <li><a href="https://git.frama-c.com/pub/frama-c/-/issues">Known issues</a></li>
51
                <li><a href="/html/bug_reporting_guidelines.html">Reporting bugs</a></li>
Allan Blanchard's avatar
Allan Blanchard committed
52
53
              </ul>
            </div>
Allan Blanchard's avatar
Allan Blanchard committed
54
          </div>
Augustin Lemesle's avatar
Augustin Lemesle committed
55

56
          <div class="tileWrapper" size="small">
Allan Blanchard's avatar
Allan Blanchard committed
57
            <div class="tileWrapperTitle">
Andre Maroneze's avatar
Andre Maroneze committed
58
              <span>Plug-in Manuals</span>
Allan Blanchard's avatar
Allan Blanchard committed
59
60
61
62
            </div>
            <div class="tile">
              <h4 class="tileTitle"><span>Plugin Development</span></h4>
              <ul>
63
                <li><a href="/download/frama-c-plugin-development-guide.pdf">Developer manual</a></li>
Allan Blanchard's avatar
Allan Blanchard committed
64
65
              </ul>
            </div>
66
            {% for plugin in site.fc-plugins %}
Allan Blanchard's avatar
Allan Blanchard committed
67
68
69
70
71
72
73
74
75
76
77
78
            <div class="tile">
              <h4 class="tileTitle">
                <span>
                  {% if plugin.short %}
                  {{ plugin.short }}
                  {% else %}
                  {{ plugin.title }}
                  {% endif %}
                </span>
              </h4>
              <ul>
                <li><a href="{{plugin.url}}">Description page</a></li>
Allan Blanchard's avatar
Allan Blanchard committed
79
                {% if plugin.manual_pdf %}
80
                <li><a href="{{plugin.manual_pdf}}">User manual</a></li>
Allan Blanchard's avatar
Allan Blanchard committed
81
82
                {% endif %}
                {% for add in plugin.additional %}
83
                <li><a href="{{add.link}}">
Allan Blanchard's avatar
Typo    
Allan Blanchard committed
84
                  {% if add.lang == "FR" %}<img src="/assets/img/icons/france-flag-waving-icon-16.png" alt="In French">{% endif %}
85
86
                  {% if add.short %}{{add.short}}{% else %}{{add.name}}{% endif %}
                </a></li>
Allan Blanchard's avatar
Allan Blanchard committed
87
88
                {% endfor %}
                {% if plugin.repo_url %}
Allan Blanchard's avatar
Allan Blanchard committed
89
90
91
92
93
                <li><a href="{{plugin.repo_url}}">External repository</a></li>
                {% endif %}
              </ul>
            </div>
            {% endfor %}
Augustin Lemesle's avatar
Augustin Lemesle committed
94
95
96
97
98
99
100
101
102
          </div>
        </div>
      </div>

      {% include footer.html %}

      <div class="clear"></div>
    </div>
  </div>