Skip to content
Snippets Groups Projects
Commit 07316639 authored by François Bobot's avatar François Bobot
Browse files

Merge branch 'colibri-doc' into 'colibri' 

Colibri doc

See merge request !1
parents df458a55 9faff560
No related branches found
No related tags found
1 merge request!1Colibri doc
Pipeline #37263 passed
Stage: deploy
    Hide whitespace changes
    Inline Side-by-side
    .gitlab-ci.yml
    + 5
    − 7
    View file @ 07316639
    ......@@ -34,12 +34,13 @@ test:
    stage: test
    script:
    - bundle exec jekyll build -d test --future
    - ./download_doc.sh test
    artifacts:
    paths:
    - test
    expire_in: 1 month
    except:
    - master
    - colibri
    tags:
    - docker
    ......@@ -54,7 +55,7 @@ check-css:
    - if [ $(grep "PurifyCSS" del-classes.o | wc -l) = 0 ]; then echo "No CSS to clean"; else cat del-classes.o; exit 1; fi;
    allow_failure: true
    except:
    - master
    - colibri
    tags:
    - docker
    ......@@ -62,15 +63,12 @@ pages:
    stage: deploy
    script:
    - JEKYLL_ENV="production" bundle exec jekyll build -d public --future
    - wget -O farith2_doc.tar.gz "https://git.frama-c.com/pub/colibrics/-/jobs/artifacts/master/raw/farith2_doc.tar.gz?job=generate-static:%20[4.12.0]"
    - mkdir -p public/html/doc/
    - tar -C public/html/doc/ -xf farith2_doc.tar.gz
    - mv public/html/doc/farith2 public/html/doc/farith
    - ./download_doc.sh public
    artifacts:
    paths:
    - public
    expire_in: 1 month
    only:
    - master
    - colibri
    tags:
    - docker
    _fc-plugins/farith.md
    + 1
    − 2
    View file @ 07316639
    ......@@ -6,8 +6,7 @@ description:
    key: main
    distrib_mode: main
    priority: 0
    manual_pdf: /download/farith-manual.pdf
    manual_html: /html/doc/farith/coq/index.html
    manual_html: /html/doc/farith/doc/F.All.html
    ---
    ## Farith
    ......
    download.html
    + 5
    − 3
    View file @ 07316639
    ......@@ -3,10 +3,12 @@
    <head>
    <title>Get Frama-C</title>
    <meta http-equiv = "refresh" content = "0; url=/html/get-frama-c.html" />
    <link rel="canonical" href="https://www.frama-c.com/html/get-frama-c.html" />
    <link rel="canonical" href="https://colibri.frama-c.com/html/get-frama-c.html" />
    <meta description = "Download and install the Frama-C analysis platform now!" />
    </head>
    <body>
    <p>Redirect to <a href="https://www.frama-c.com/html/get-frama-c.html">Get Frama-C</a></p>
    <p>Redirect
    to <a href="https://colibri.frama-c.com/html/get-frama-c.html">Get
    Colibri tools</a></p>
    </body>
    </html>
    \ No newline at end of file
    </html>
    download_doc.sh 0 → 100755
    + 11
    − 0
    View file @ 07316639
    #!/bin/sh -eux
    ROOT=$1
    wget -O farith2_doc.tar.gz "https://git.frama-c.com/pub/colibrics/-/jobs/artifacts/master/raw/farith2_doc.tar.gz?job=generate-static:%20[4.12.0]"
    mkdir -p $ROOT/html/doc/
    tar -C $ROOT/html/doc/ -xf farith2_doc.tar.gz
    mv $ROOT/html/doc/farith2 $ROOT/html/doc/farith
    html/get-frama-c.html
    + 27
    − 31
    View file @ 07316639
    ---
    layout: default
    css: get-framac
    title: Get Frama-C
    description: Download and install the Frama-C analysis platform now!
    title: Get Colibri tools
    description: Download and install Colibri, Colibri2, Colibrics
    ---
    <body class="page nonTouch">
    ......@@ -14,7 +14,7 @@ description: Download and install the Frama-C analysis platform now!
    <div id="container" class="mainContainer">
    <div class="getFramaC">
    <div class="wrap">
    <h1 class="pageTitle">Choose for which OS you want Frama-C</h1>
    <h1 class="pageTitle">Choose for which OS you want Colibri2</h1>
    <div class="OS codeTabs">
    <a href="#" role="button" class="tab-up tab-up-linux" onClick="clickTab('linux')"><b>Linux</b></a> <a href="#" role="button" class="tab-up tab-up-mac" onClick="clickTab('mac')"><b>Mac</b></a> <a href="#" role="button" class="tab-up tab-up-windows" onClick="clickTab('windows')"><b>Windows (WSL)</b></a>
    ......@@ -29,29 +29,29 @@ description: Download and install the Frama-C analysis platform now!
    sudo apt install opam <span class="shell-linux-comment"># or dnf, pacman, etc.</span>
    <span class="shell-linux-comment"># 2. Install Frama-C's dependencies</span>
    <span class="shell-linux-comment"># 2. Install Colibri2's dependencies</span>
    opam install depext
    opam depext frama-c
    opam depext colibri2
    <br>
    <span class="shell-linux-comment"># 3. Install Frama-C itself</span>
    opam install frama-c</pre>
    <span class="shell-linux-comment"># 4. Install Colibri2 itself</span>
    opam install colibri2</pre>
    </div>
    <div class="codeTab tab-mac hide">
    <pre class="shell-mac">
    <span class="shell-mac-comment"># 1. Install <a href="https://brew.sh/">Homebrew</a></span>
    <span class="shell-mac-comment"># 2. Install required dependencies for Frama-C</span>
    brew install opam gmp gtk+ gtksourceview libgnomecanvas
    <span class="shell-mac-comment"># 2. Install required dependencies for Colibri2</span>
    brew install opam gmp gtk+
    <span class="shell-mac-comment"># 3. Configure GTK library</span>
    export PKG_CONFIG_PATH=/usr/local/opt/libffi/lib/pkgconfig:/usr/local/opt/libxml2/lib/pkgconfig:/usr/local/lib/pkgconfig
    <span class="shell-mac-comment"># 4. Install recommended dependencies for Frama-C</span>
    brew install graphviz zmq
    <!-- <span class="shell-mac-comment"># 4. Install recommended dependencies for Colibri2</span> -->
    <!-- brew install zmq -->
    <span class="shell-mac-comment"># 5. Finally install Frama-C</span>
    opam install frama-c</pre>
    <span class="shell-mac-comment"># 4. Finally install colibri2</span>
    opam install colibri2</pre>
    </div>
    <div class="codeTab tab-windows hide">
    ......@@ -66,33 +66,22 @@ opam init --disable-sandboxing --shell-setup
    eval $(opam env)
    opam install -y depext
    <span class="shell-win-comment"># 3. Install graphical dependencies</span>
    opam depext --install -y lablgtk3 lablgtk3-sourceview3
    <!-- <span class="shell-win-comment"># 3. Install graphical dependencies</span> -->
    <!-- opam depext --install -y lablgtk3 lablgtk3-sourceview3 -->
    <span class="shell-win-comment"># 4. Install Frama-C</span>
    opam depext --install -y frama-c</pre>
    <span class="shell-win-comment"># 4. Install Colibri2</span>
    opam depext --install -y colibri2</pre>
    </div>
    </div>
    </div>
    </div>
    <div class="otherConfiguration">
    For detailed installation instructions, <a target="_blank" href="https://git.frama-c.com/pub/frama-c/blob/master/INSTALL.md">click here</a>
    <br>All Frama-C releases are available <a href="/html/framac-versions.html">from this page</a>
    </div>
    {% if site.fc-versions.last.beta %}
    <div class="otherVersion">
    The beta version of the next Frama-C release is available <a href="{{ site.fc-versions.last.url }}">here</a>
    </div>
    {% endif %}
    <h1 class="pageTitle">Downloads</h1>
    <div class="tileWrapper" size="big">
    <div class="tile">
    <h4 class="tileTitle"><span>Frama-C and ACSL</span></h4>
    <h4 class="tileTitle"><span>Colibri2</span></h4>
    <ul>
    <li><a href="/download/frama-c-source-dist.tar.gz">Frama-C source distribution</a></li>
    <li><a href="/download/frama-c-user-manual.pdf">Frama-C user manual</a></li>
    <li><a href="/download/frama-c-plugin-development-guide.pdf">Plug-in development guide</a></li>
    <li><a href="/download/frama-c-acsl-implementation.pdf">ACSL implementation</a></li>
    <li><a href="https://git.frama-c.com/pub/colibrics/-/jobs/artifacts/master/raw/bin/colibri2?job=generate-static:%20[4.12.0]">Colibri2
    Nightly development version, Linux binary</a></li>
    </ul>
    </div>
    <div class="tile">
    ......@@ -107,6 +96,13 @@ opam depext --install -y frama-c</pre>
    </a>
    </li>
    {% endif %}
    {% if plugin.manual_html %}
    <li>
    <a href="{{ plugin.manual_html }}">
    {% if plugin.short %}{{ plugin.short }}{% else %}{{ plugin.title }}{% endif %} manual
    </a>
    </li>
    {% endif %}
    {% endfor %}
    </ul>
    </div>
    ......
    0% or .
    You are about to add 0 people to the discussion. Proceed with caution.
    Finish editing this message first!
    Please register or to comment