diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a672576 --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +*.aux +*.fdb* +*.fls +*.log +*.pdf + +!logo.pdf diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..7373ccc --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,16 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), + +## [Unreleased] + +## [0.0.1] - 2019-09-30 +### Added + * CHANGELOG file to follow the changes of this code + * README file to help use the code + * LICENSE file, WTFPL license v2.0 + * formationTitle.sty, the package for the new maketitle commande + * plan.tex, the example file for the training plan + * logo.pdf, WTFPL logo + * .gitignore file, ignore the LaTeX compilation files diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..b6c0ad3 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,13 @@ +DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE + Version 2, December 2004 + +Copyright (C) 2004 Sam Hocevar + +Everyone is permitted to copy and distribute verbatim or modified +copies of this license document, and changing it is allowed as long +as the name is changed. + +DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE +TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + +0. You just DO WHAT THE FUCK YOU WANT TO. diff --git a/README.md b/README.md index edbb6fa..643ce7c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,36 @@ -# PlanFormation +# Formation plan -Plan de formation vide \ No newline at end of file +A simple formation schedule to better organize trainings. + +## Getting started + +### Logo +By default, the logo is the logo.pdf file. +With the command `\logo` it is possible to change it. + +### Context +The command `\context` defines the context in which this training will be given. + +### Subject +The subject of the training is specified by the command `\subject`. + +### Subtopic +An optional short sentence to describe the subject or to clarify it. +The command `\subtopic` allows you to configure it. +La commande `\subtopic` permet de la configurer. + +### Objectives +The objectives of the training are defined by the command `\objectives`. +They will often be on several lines, that is not a problem. + +### Messages +Similar to the objectives, the command `\messages` allows us to define +the messages we want to convey to learners during the training. + +## Authors + + * Gregory Trolliet - Initial work - [Website](https://trolliet.info) + +## Licence +This project is licensed under the WTFPL License - see +the [LICENSE.md](LICENSE.md) file for details.