Skip to content
Snippets Groups Projects
start.md 2.83 KiB
Newer Older
Augustin Lemesle's avatar
Augustin Lemesle committed
---
layout: clean_page
---
# Documentation

<!-- Is on-topic in this wiki anything that may be of help to others users of -->
<!-- Frama-C and related tools: tips, changes that you have noticed, -->
<!-- workarounds, etc. If it should have been in the manual, put it here. If -->
<!-- it's too minute, platform-specific, or temporary to be a good fit for -->
<!-- the manual, put it here. Your goal should be to make a wiki so clear and -->
<!-- functional that it puts the authors of Frama-C's various manuals to -->
<!-- shame. -->

Modification for this documentation, as for all this site, can be proposed by
submitting a merge requests at the corresponding
[https://git.frama-c.com/frama-c/frama-c.frama-c.com](gitlab repository).

For plug-ins documentation, some pages can be found here but all of them are
otherwise available [/html/kernel-plugin.html](on the dedicated page).

Is on-topic anything that may be of help to others users of
Frama-C and related tools: tips, changes that you have noticed,
workarounds, etc.

<!--  If it should have been in the manual, put it here. If -->
<!-- it's too minute, platform-specific, or temporary to be a good fit for -->
<!-- the manual, put it here. Your goal should be to make a wiki so clear and -->
<!-- functional that it puts the authors of Frama-C's various manuals to -->
<!-- shame. -->

-----

# Compilation and Installation

Current and old releases of Frama-C are available on [this
page](html/get-frama-c.html). It contains the official
installation instructions for supported systems.

Otherwise, [each releases](https://git.frama-c.com/pub/frama-c/blob/master/INSTALL.md) contains extra instructions
for compiling from source.

<!-- We could copy INSTALL.md to this repo -->

# Contributing

Frama-C is an open-source project which could be contrinuted through merge
requests at this [Gitlab repository](https://git.frama-c.com/pub/frama-c/). The
modalities are described in this [document](https://git.frama-c.com/pub/frama-c/CONTRIBUTING.md)

<!-- We could copy CONTRIBUTING.md to this repo -->

# FAQ, Tips and Tricks

See [this page](/dokuwiki/faq.html), or this [slightly older
one](/dokuwiki/frequently_asked_questions.html).

# External plug-ins

[External plug-ins](/dokuwiki/external_plugins.html) that you may find
useful are available. The plug-ins currently described are **Jessie**,
**Celia** and **Werror**.

# Known issues

  - The BTS has a [list of known
    issues](http://bts.frama-c.com/view_all_bug_page.php).
  - See [bug reporting guidelines](/dokuwiki/bug_reporting_guidelines.html) to
    report a bug.

# Open positions

[Open positions](/dokuwiki/positions.html) in the Frama-C team are
available.

# Works about Frama-C

  - [List of publications](/dokuwiki/publications.html)
  - [Exercises](/dokuwiki/exercises.html)
  - [Teaching](/dokuwiki/teaching.html)
  - [Tutorials](/dokuwiki/tutorial.html)