Commit d90fef4c authored by Hugues's avatar Hugues

Merge branch 'review-version' into develop

parents 8003fe27 b3d23b2a
# Scampi #
Scampi est un ensemble de composants sass/js/html accessibles et responsive développés à la DILA (Direction de l'information légale et administrative). Il vise à être utilisé en interne et par nos prestataires ou partenaires.
Scampi est un ensemble de composants sass/js/html accessibles et responsive développés à la DILA (Direction de linformation légale et administrative). Il vise à être utilisé en interne et par nos prestataires ou partenaires.
- - -
......@@ -27,9 +27,9 @@ Répertoires de ce dépôt :
* **test/** : fichiers html/css/js de démonstration
* le présent README
Note 1: les modules préfixés '''u-''' sont destinés à la phase de développement et l'élaboration de styleguide.
Note 1: les modules préfixés '''u-''' sont destinés à la phase de développement et lélaboration de styleguide.
Note 2: pour compiler la scss d'exemple du répertoire _test :
Note 2: pour compiler la scss dexemple du répertoire _test :
```bash
sass --watch _test
......@@ -37,7 +37,7 @@ sass --watch _test
## Dépendances
Scampi est développé à l'aide du préprocesseur Sass. Il vous faudra donc disposer d'un outil de compilation. Le pôle internet utilise la version [gulp-sass](https://www.npmjs.com/package/gulp-sass) de nodejs mais vous pouvez utiliser tout compilateur de votre choix.
Scampi est développé à l’aide du préprocesseur Sass. Il vous faudra donc disposer d’un outil de compilation. Le pôle internet utilise la version [gulp-sass](https://www.npmjs.com/package/gulp-sass) de nodejs mais vous pouvez utiliser tout compilateur de votre choix.
## Installation
......@@ -45,23 +45,25 @@ Il existe deux méthodes pour utiliser Scampi dans un projet :
### En submodule
Si vous utilisez Git pour vos développements et souhaitez mettre à jour Scampi au fil de ses développements, ajoutez Scampi à votre projet en déclarant un submodule au sein de votre répertoire de styles. Cela permet d'être informé des mises à jour de Scampi et de les récupérer si vous le souhaitez.
Si vous utilisez Git pour vos développements et souhaitez mettre à jour Scampi au fil de ses développements, ajoutez Scampi à votre projet en déclarant un submodule au sein de votre répertoire de styles. Cela permet dêtre informé des mises à jour de Scampi et de les récupérer si vous le souhaitez.
### En téléchargeant Scampi
Téléchargez l'archive de Scampi et placez-la dans votre répertoire de styles. Cette méthode vous autorise à modifier ses fichiers pour votre propre usage.
Téléchargez larchive de Scampi et placez-la dans votre répertoire de styles. Cette méthode vous autorise à modifier ses fichiers pour votre propre usage.
Scampi est conçu pour être utilisé avec Sass. Néanmoins, si vous souhaitez télécharger la CSS et les js compilés pour les surcharger ensuite vous pouvez également télécharger [Scampi Vanilla]() *à venir avant la fin de 2016*.
## Documentation
Sauf mention précisée dans sa documentation, chaque module est utilisable sans dépendre d'aucun autre et ne nécessite que le chargement du core.
Sauf mention précisée dans sa documentation, chaque module est utilisable sans dépendre daucun autre et ne nécessite que le chargement du core.
Un fichier markdown est présent dans chaque module pour documenter son but et son usage. Lire les [principes d'utilisation et de personnalisation d'un module](modules/README.md).
Un fichier markdown est présent dans chaque module pour documenter son but et son usage. Lire les [principes d’utilisation et de personnalisation d’un module](modules/README.md).
Démonstration et documentation complète de Scampi à venir sur un site dédié *(fin décembre 2016)*.
Le projet est versionné selon la [gestion sémentique de version](http://semver.org/lang/fr/).
## Contributions
......@@ -73,6 +75,9 @@ Si vous détectez une anomalie ou souhaitez proposer une évolution vous pouvez
| nom | version | licence | url | informations complémentaires |
| :--- | :------ | :------ | :-- | :-----
| Normalise.css | v3.0.3 | MIT License | github.com/necolas/normalize.css |
| Twitter Bootstrap | v4.0.0-alpha-4 | MIT License | https://github.com/twbs/bootstrap |
| Adobe-Blank | v1.045 | SIL OPEN FONT LICENSE Version 1.1 | https://github.com/adobe-fonts/adobe-blank |
## Auteurs
......@@ -83,12 +88,12 @@ Pidila (Pôle internet de la DILA).
Benoît Dequick - Hugues Moreno - Anne Cavalier. Nous écrire : prenom.nom@dila.gouv.fr
#### Liste d'échanges et d'information :
#### Liste d’échanges et d’information :
[S'abonner](https://framalistes.org/sympa/subscribe/pidila-tools).
[Sabonner](https://framalistes.org/sympa/subscribe/pidila-tools).
## License
[CeCILL-C](http://www.cecill.info/licences.fr.html) (compatible GPL et MIT).
Note : cette page s'inspire de [https://github.com/edx/ux-pattern-library](https://github.com/edx/ux-pattern-library)
Note : cette page sinspire de [https://github.com/edx/ux-pattern-library](https://github.com/edx/ux-pattern-library)
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