|
| 1 | +# Sud Web 2017 |
| 2 | + |
| 3 | +[](https://travis-ci.org/sudweb/2017) |
| 4 | +[](https://stackshare.io/sud-web/sud-web) |
| 5 | + |
| 6 | +Site internet du cycle de conférences annuel Sud Web, dont la 7e édition aura lieu à Aix-en-Provence les 19 et 20 mai 2017. |
| 7 | + |
| 8 | +[https://sudweb.fr/](https://sudweb.fr/) |
| 9 | + |
| 10 | +## Pré-requis |
| 11 | +Le site est généré à l'aide de [Jekyll](http://jekyllrb.com/) et nécessite Ruby 2.3 (voir `.ruby-version`) |
| 12 | + |
| 13 | +Nous vous recommandons de gérer l'installation de Ruby via [rbenv](http://rbenv.org/). |
| 14 | + |
| 15 | +Sous Mac OS X, vous pouvez utiliser [Homebrew](http://brew.sh/) pour cela |
| 16 | +```bash |
| 17 | +$ brew install rbenv ruby-build |
| 18 | +``` |
| 19 | + |
| 20 | +Sous GNU/Linux, certaines librairies sont nécessaires (à adapter à votre gestionnaire de paquets) : |
| 21 | +```bash |
| 22 | +sudo apt-get install -y libreadline-dev build-essential |
| 23 | +``` |
| 24 | +Puis pour rbenv et ruby-build, préférer une installation par git : |
| 25 | +```bash |
| 26 | +$ git clone https://github.com/rbenv/rbenv.git ~/.rbenv |
| 27 | +$ cd ~/.rbenv && src/configure && make -C src |
| 28 | +$ echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc |
| 29 | +$ git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build |
| 30 | +``` |
| 31 | + |
| 32 | +## Installation |
| 33 | + |
| 34 | +Si vous n'avez pas déjà cloné le dépot : |
| 35 | +```bash |
| 36 | +$ git clone https://github.com/sudweb/2017.git && cd 2017 |
| 37 | +``` |
| 38 | +Si bundler n'est pas installé |
| 39 | +```bash |
| 40 | +$ gem install bundler |
| 41 | +``` |
| 42 | +Pour installer toutes les dépendances du projet : |
| 43 | +```bash |
| 44 | +$ bundle install |
| 45 | +``` |
| 46 | +Pour installer la bonne version de Ruby |
| 47 | +```bash |
| 48 | +$ rbenv install |
| 49 | +``` |
| 50 | + |
| 51 | +## Travailler en local |
| 52 | + |
| 53 | +Pour travailler sur le site et surveiller les modifications : |
| 54 | +```bash |
| 55 | +$ bundle exec foreman start |
| 56 | +``` |
| 57 | +ou |
| 58 | +```bash |
| 59 | +$ bundle exec jekyll serve |
| 60 | +``` |
| 61 | + |
| 62 | +Si vous modifiez le fichier `_config.yml`, il faut couper et relancer Jekyll. |
| 63 | + |
| 64 | +Le site est maintenant accessible en local à l'adresse http://127.0.0.1:4000/2017/ |
| 65 | + |
| 66 | +Pour plus d'information sur l'utilisation de Jekyll, reportez-vous à la [documentation officielle](http://jekyllrb.com/docs/home/). |
| 67 | + |
| 68 | +## Styleguide et notes d'intégration |
| 69 | + |
| 70 | +* [Notes d'intégration](notes-integration.md) de @Twikito |
| 71 | + |
| 72 | +## Contribution |
| 73 | + |
| 74 | +Pour toute demande, merci de [créer une issue](https://github.com/sudweb/2017/issues/new) sur GitHub. |
| 75 | + |
| 76 | +Si vous souhaitez nous aider, vous pouvez [copier](https://help.github.com/articles/fork-a-repo/) le dépôt, faire vos modifications dans une nouvelle branche et [faire une demande de fusion](https://github.com/sudweb/2017/pulls). |
| 77 | + |
| 78 | +Toute modification doit faire l'objet d'une [pull request](https://github.com/sudweb/2017/pulls) et doit passer les tests avant de pouvoir être fusionnée. |
| 79 | + |
| 80 | +## Tests |
| 81 | + |
| 82 | +Avant de soumettre votre pull-request, vérifiez que les tests passent : |
| 83 | + |
| 84 | +```bash |
| 85 | +$ script/cibuild |
| 86 | +Running ["ScriptCheck", "LinkCheck", "ImageCheck"] on ./_site on *.html... |
| 87 | + |
| 88 | +HTML-Proofer finished successfully. |
| 89 | +``` |
| 90 | + |
| 91 | +## Licence |
| 92 | + |
| 93 | +Ce code est publié sous licence MIT. |
0 commit comments