README.adoc 1.76 KB
Newer Older
Emmanuel Milou's avatar
Emmanuel Milou committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
= README
Emmanuel Milou <emmanuel.milou@savoirfairelinux.com>
2016-10-31
Après-midi Contributions

:keywords: SFL, Continuous Integration, AsciiDoc, Asciidoctor
:page-layout: base
:page-description: {description}
:page-keywords: {keywords}
:toc: right
ifdef::env-site[]
:toc: right
:icons: font
:toc-placement: preamble
endif::[]
ifndef::env-site[]
:toc: right
:icons: font
:idprefix:
:idseparator: -
:sectanchors:
:source-highlighter: highlight.js
endif::[]
:experimental:
:mdash: &#8212;
:language: asciidoc
:source-language: {language}
// Refs
:doc-asciidoctor: http://asciidoctor.org/docs/asciidoc-recommended-practices/


== Les Après-Midi Contributions

L'objectif des Après-midi Contributions est de favoriser le travail d'équipe,
la collaboration et les bonnes pratiques à travers des ateliers pratiques de
contributions à des logiciels libres.

== About this document

The main report uses the Asciidoc syntax generator.
It is a convenient tool allowing to write documentation in raw text files, and convert them to HTML or PDF later on.

Visit https://github.com/asciidoctor[Asciidoctor @ *GitHub*] for more informations.
The {doc-asciidoctor}[AsciiDoc Recommanded Practices] is also recommanded.

To generate a HTML version, first install asciidoctor package on your Linux distribution, then issue following command:

 $ asciidoctor pm-contributions.adoc

The pm-contributions.html is generated in the current directory.

Asciidoctor provides a native PDF renderer for Asciidoc. Still in alpha, but worth the try. Please follow the instructions on the official documentation to
install it, then issue following command:

 $ asciidoctor-pdf -a pdf-stylesdir=resources -n -a pdf-style=sfl pm-contributions.adoc

The _pm-contributions.pdf_ file shall be created in the current directory.