Commit 79c514bb authored by Guillaume Perréal's avatar Guillaume Perréal
Browse files

Ajout de documentation.

No related merge requests found
Showing with 68 additions and 0 deletions
+68 -0
## 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
```
README.md 0 → 100644
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.
Supports Markdown
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