Commit 216cbe92 authored by Emmanuel Milou's avatar Emmanuel Milou
Browse files

Add documentation

parent 5ea4cff7
= Boilerplate template for Drupal projects
SFL Drupal Team <drupal@lists.savoirfairelinux.net>
v2.0, 2016-03-10
:keywords: Drupal, SFL, SFLinux, AsciiDoc, Asciidoctor
:page-layout: base
:page-description: {description}
......@@ -13,7 +15,7 @@ ifndef::env-site[]
:idprefix:
:idseparator: -
:sectanchors:
:source-highlighter: highlight.js
:source-highlighter: highlightjs
endif::[]
:experimental:
:mdash: &#8212;
......@@ -28,9 +30,9 @@ endif::[]
:gitlab-sflinux: https://gitlab.savoirfairelinux.com/drupal/sflinux
/ __/ __/ / / _/ |/ / / / / |/_/
_\ \/ _// /___/ // / /_/ /> <
/___/_/ /____/___/_/|_/\____/_/|_|
/ __/ __/ / / _/ |/ / / / / |/_/
_\ \/ _// /___/ // / /_/ /> <
/___/_/ /____/___/_/|_/\____/_/|_|
// (to make a title: echo " CLIENT.PROJECT" | figlet -f smslant )
......@@ -40,7 +42,6 @@ It uses our custom Drupal distribution {gitlab-sflinux}[*SFLinux*] as codebase.
TIP: More information on our Drupal practices at Savoir-faire Linux are described in {sfl-wiki-drupal}[the official Wiki].
== System Requirements
This installation profile has been designed to work with Drupal 7, and is compatible with PHP > 5.3.
......@@ -90,6 +91,8 @@ This document 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.
To generate a HTML version, first install asciidoctor package on your
Linux distribution, then issue following command:
......@@ -103,3 +106,4 @@ distribution, then issue following command:
$ a2x -f pdf --dblatex-opts "-P latex.output.revhistory=0" README.adoc
The README.pdf file shall be created.
Markdown is supported
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