Skip to content

Commit 503c07e

Browse files
author
Yvain Liechti
committed
update commit to GSK v4
1 parent e294491 commit 503c07e

File tree

1 file changed

+19
-86
lines changed

1 file changed

+19
-86
lines changed

readme.md

+19-86
Original file line numberDiff line numberDiff line change
@@ -1,103 +1,36 @@
1-
Clever _Garden Starter Kit_
2-
===============================================================================
1+
# Clever _Garden Starter Kit_
32

4-
Ce dépôt sert de kit de démarrage pour les projets d'intégration statique.
3+
This project is a package of usefull gulp tasks for static project.
54

6-
Il contient toutes nos bonnes pratiques et tous les outils nécessaires pour
7-
nos projets d’intégration statique chez Clever Age. Parmi tous les outils
8-
présents dans ce kit, vous trouverez ceux qui doivent être utilisés
9-
obligatoirement aussi bien que ceux qui sont simplement recommandés.
5+
It contains every tools for implementing our best practicesrequired in our static project at Clever Age.
106

11-
Chaque outil utilisé dispose d’une documentation dédiée sur la façon de
12-
l'utiliser dans notre contexte. Cette documentation est rédigée au [format
13-
Markdown](https://daringfireball.net/projects/markdown/syntax) et est disponible dans le répertoire `docs` de ce dépôt.
7+
Each tool has a dedicated documentation about his use in our context. This documentation is edited in [Markdown format](https://daringfireball.net/projects/markdown/syntax) and available in `docs` directory of this repository.
148

9+
## Initialize your project
1510

16-
Créer un nouveau projet
17-
-------------------------------------------------------------------------------
18-
Pour créer un nouveau projet, suivez simplement les instructions ci-après.
11+
1. Initialize git `git init` (or clone your project repository if existing yet).
12+
2. Initialize your project with `npm init`.
13+
3. Install the GSK `npm install cleverage/garden-starter-kit#next` (`next` is branch for v4 alpha).
1914

20-
> **NOTE :** _Il s'agit ici des instructions manuelles à suivre. Cependant, à terme,
21-
il est prévu qu'un script d'installation soit disponible pour simplifier le démarage._
15+
During installation, GSK will ask which html and css engines you want (Twig and Sass by default).
2216

23-
## Initialisez votre projet
24-
Vous avez deux options pour démarrer votre projet :
17+
The GSK will install required dependencies for these engines and prepare some files in your project
2518

26-
1. [Télécharger](https://github.com/cleverage/garden-starter-kit/archive/master.zip) le contenu de ce dépôt et l'utiliser comme base de démarrage
27-
2. Clôner ce dépôt avec Git (voir ci-après)
19+
⚠ You won’t be able to change these choices later.
2820

29-
### Clôner le kit de démarrage avec Git
30-
Si vous le souhaitez, vous pouvez directement clôner ce dépôt avec Git.
21+
4. You can commit your change and start your project.
3122

32-
Le plus simple :
23+
## Engine choices informations
3324

34-
```bash
35-
$ cd ~/monProjet
36-
$ git clone [email protected]:cleverage/garden-starter-kit.git .
37-
$ rm -rf .git
38-
```
39-
40-
Il ne vous reste plus qu’à initialiser le dépôt git de votre projet et commiter
41-
le _starter kit_ que vous avez récupéré pour commencer votre projet :
42-
43-
```bash
44-
$ git init
45-
$ git add --all
46-
$ git commit -m "First commit"
47-
$ git remote add origin <URL-de-votre-depot-git>
48-
$ git push -u origin master
49-
```
50-
51-
> **NOTE :** _Si la branche master existe déjà et/ou est protégée, il faut faire le `git push` sur une autre branche (`git push -u origin gsk`) puis faire une « pull request »_
52-
53-
### Configurer le GSK
54-
55-
À l’initialisation du projet vous devez choisir quels outils vont être utilisés pour builder le html et le css selon les besoins du projet.
56-
57-
Les outils listés ci-après sont à configurer via le fichier `config.json`. Si vous n’utilisez que les choix recommandés, ils sont déjà configurés par défaut.
58-
59-
Voir les instructions de configuration ci-après :
60-
61-
#### CSS
62-
* [Sass](docs/css/sass.md) [Recommandé]
25+
### CSS
26+
* [Sass](docs/css/sass.md) [Recommanded]
6327
* [Sass/Compass](docs/css/compass.md)
6428
* [Stylus](docs/css/stylus.md)
6529
* [LESS](docs/css/less.md)
66-
* Si vous ne choisissez pas de préprocesseur, le projet n’utilisera que PostCss
6730

68-
#### HTML
69-
* [Twig](docs/html/twig.md) [Recommandé]
31+
### HTML
32+
* [Twig](docs/html/twig.md) [Recommanded]
7033
* [Handlebars](docs/html/handlebars.md)
7134

72-
#### JavaScript
73-
* [Webpack + NPM](docs/js/webpack.md) [Recommandé]
74-
75-
### Finalisation
76-
77-
Une fois les étapes précédantes executées, vous n’êtes déjà plus sur le GSK mais dans votre nouveau projet.
78-
79-
1. Remplacez votre `readme.md` par le `readme.dist.md`.
80-
2. Dans celui-ci, remplacez `PROJECT_NAME` par le nom de votre projet et `GIT_REPO_URL` par l’url de son dépôt git.
81-
3. Changez dans le `package.json` toutes les entrées suivantes :
82-
83-
```json
84-
"name": "garden-starterkit",
85-
"homepage": "https://github.com/cleverage/garden-starter-kit",
86-
"title": "Garden Starter Kit",
87-
"description": "Set de base pour les projets Garden statiques.",
88-
"version": "2.0.0-beta9",
89-
"license" : "MIT",
90-
"repository": {
91-
"type": "git",
92-
"url": "https://github.com/cleverage/garden-starter-kit.git"
93-
},
94-
```
95-
96-
4. Changez ou supprimez le fichier `LICENSE`.
97-
98-
_Bravo !! Votre projet est en route._
99-
100-
### Pour aller plus loin
101-
102-
Vous pouvez supprimer les dépendances inutiles à votre projet comme Less si vous utilisez Sass.
103-
35+
### JavaScript
36+
* [Webpack + NPM](docs/js/webpack.md)

0 commit comments

Comments
 (0)