From 3fdd6c5f27c95974fdc81657da4b4f04d5bc779e Mon Sep 17 00:00:00 2001 From: Robert Alessi Date: Mon, 10 Sep 2018 22:01:41 +0200 Subject: basic readme --- README.md | 44 +++++++++++++++++++++++++++++++++++++++++--- README.tex | 40 +++++++++++++++++++++++++++++++++++++--- _preamble.tex | 1 + 3 files changed, 79 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e946d8b..ad03dba 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,46 @@ --- author: - Robert Alessi -title: Cours sur LaTeX et Python +title: 'Mode d’emploi' --- -Présentation -============ +Comment utiliser ce dépôt git +============================= + +Veuillez vous référer à [cette page de notre +wiki](https://notabug.org/ralessi/courses/wiki). + +Compilation +=========== + +Voici la liste des éléments logiciels qu’il faut installer: + +1. [GNU Make](https://www.gnu.org/software/make/) + +2. Une distribution dérivée de [TeXLive](http://tug.org/texlive/), à + savoir: + + 1. Linux: [TeXLive](http://tug.org/texlive/) + + 2. MacOs: [MacTeX](http://tug.org/mactex/) + + 3. Windows: [proTeXt](http://tug.org/protext/) + + Rem. L’installation + doit être *complète*: il faut donc choisir l’option *Set + installation scheme: **scheme-full*** + +Utilisation de la ligne de commande +----------------------------------- + +#### Compiler les fichiers + + make pdf + +#### Revenir à la version initiale + + make clean + +#### Mise à jour + + git pull diff --git a/README.tex b/README.tex index 9d3b136..b728a3d 100644 --- a/README.tex +++ b/README.tex @@ -1,15 +1,49 @@ \documentclass{article} \usepackage[french]{babel} -\title{Cours sur \LaTeX\ et Python} +\usepackage{hyperref} +\hypersetup{unicode,colorlinks} +\title{Mode d'emploi} \author{Robert Alessi} -\date{} \begin{document} \maketitle -\section{Présentation} +\section{Comment utiliser ce dépôt git} +Veuillez vous référer à +\href{https://notabug.org/ralessi/courses/wiki}{cette page de notre + wiki}. +\section{Compilation} +Voici la liste des éléments logiciels qu'il faut installer: +\begin{enumerate} +\item \href{https://www.gnu.org/software/make/}{GNU Make} +\item Une distribution dérivée de + \href{http://tug.org/texlive/}{\TeX{}Live}, à savoir: + \begin{enumerate} + \item Linux: \href{http://tug.org/texlive/}{\TeX{}Live} + \item MacOs: \href{http://tug.org/mactex/}{Mac\TeX} + \item Windows: \href{http://tug.org/protext/}{pro\TeX{}t} + \end{enumerate} + \textsc{Rem.} L'installation doit être \emph{complète}: il faut donc + choisir l'option \emph{Set installation scheme: \textbf{scheme-full}} +\end{enumerate} +\subsection{Utilisation de la ligne de commande} + +\paragraph{Compiler les fichiers} +\begin{verbatim} +make pdf +\end{verbatim} + +\paragraph{Revenir à la version initiale} +\begin{verbatim} +make clean +\end{verbatim} + +\paragraph{Mise à jour} +\begin{verbatim} +git pull +\end{verbatim} \end{document} diff --git a/_preamble.tex b/_preamble.tex index ff62021..a0b261e 100644 --- a/_preamble.tex +++ b/_preamble.tex @@ -11,6 +11,7 @@ \usepackage[breakable, skins, listings, xparse]{tcolorbox} \usepackage{hyperref} +\hypersetup{unicode,colorlinks} \usepackage{hyperxmp} \usepackage{uri} \usepackage[type={CC}, modifier={by-sa}, version ={3.0}]{doclicense} -- cgit v1.2.3