From 79c514bb7e8abf46bc9c36f617cde469e04f7f9e Mon Sep 17 00:00:00 2001
From: Perreal Guillaume <guillaume.perreal@irstea.fr>
Date: Wed, 10 Apr 2019 13:12:28 +0200
Subject: [PATCH] Ajout de documentation.

---
 CUSTOMIZATION.md | 20 ++++++++++++++++++++
 README.md        | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 68 insertions(+)
 create mode 100644 CUSTOMIZATION.md
 create mode 100644 README.md

diff --git a/CUSTOMIZATION.md b/CUSTOMIZATION.md
new file mode 100644
index 0000000..09a3a77
--- /dev/null
+++ b/CUSTOMIZATION.md
@@ -0,0 +1,20 @@
+
+## Remplacer `README.md`
+
+Y décrire comment utiliser le package...
+
+## Choisir une license
+
+Et adapter le contenu des fichiers `LICENSE`, `.docheader`.
+
+## Editer `composer.json`
+
+* Editer les métadonnées : `name`, `description`, `type`, `license`.
+* Supprimer/remplacer les scripts `post-install-cmd`, `post-update-cmd` et `customize-reminder`.
+* Corriger les namespaces des sections `autoload` et `autoload-dev`.
+
+## Supprimer les fichiers modèles
+
+```shell
+rm src/*.php tests/*.php CUSTOMIZATION.md
+```
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cf4ea08
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+Ce projet peut servir de modèle pour tout nouveau paquet PHP.
+
+## Usage
+
+Il peut être utilisé directement avec composer :
+
+    composer create-project irstea/php-skeleton my-package-directory
+
+Une fois le projet crée, il y a encore quelques étapes *indispensables$ à suivre pour terminer l'initialisation, cf. [CUSTOMIZATION.md](CUSTOMIZATION.md).
+
+## Ce qu'il contient
+
+* un squelette d'organisation des sources ([`src/`](src) et [`tests/`](tests)),
+
+* un [`composer.json`](composer.json) qui inclut les outils suivants:
+
+    * composer-require-checker
+    * php-cs-fixer (via irstea/php-cs-fixer-config)
+    * php-parallel-lint
+    * phpcpd
+    * phploc
+    * phpmd (via irstea/phpmd-config)
+    * phpstan (via irstea/phpstan-config)
+    * phpunit
+    * security-checker
+
+* une préconfiguration pour les outils suivants:
+
+    * [editorconfig](.editorconfg)
+    * [php-cs-fixer](.php_cs.dist)
+    * [phpmd](phpmd-ruleset.xml)
+    * [phpstan](phpstan.neon)
+    * [phpunit](phpunit.xml)
+
+* un [`.gitlab-ci.yml`](.gitlab-ci.yml) qui utilise les outils précédemment cité.
+
+## Ce qu'il ne contient pas
+
+* Un squelette d'application Symfony :
+
+    * Tous les packages ne sont pas des applications Symfony.
+    * Les nouvelles versions de Symfony sortent trop rapidement pour espérer suivre.
+    * Pour les nouveaux projets Symfony, il faut utiliser `symfony/flex` de toute façon.
+
+* Un squelette pour docker-composer :
+
+    * Tous les packages n'en ont pas besoin.
+    * C'est très dépendant des applications.
-- 
GitLab