From 35d320364776ac35d0b9db7b40fdb7d6a6280a05 Mon Sep 17 00:00:00 2001 From: ouidade Date: Wed, 31 Mar 2021 20:01:49 +0200 Subject: [PATCH] readme --- README.md | 95 ++++++++++++++++++++++++------------------------------- 1 file changed, 42 insertions(+), 53 deletions(-) diff --git a/README.md b/README.md index 562349f..6fd35b0 100644 --- a/README.md +++ b/README.md @@ -5,19 +5,7 @@ [![Discord](https://img.shields.io/discord/501836936584101899.svg?logo=discord&colorB=728ADA&label=Discord%20Chat)](https://chat.getgrav.org) [![PHP Tests](https://github.com/getgrav/grav/workflows/PHP%20Tests/badge.svg?branch=develop)](https://github.com/getgrav/grav/actions?query=workflow%3A%22PHP+Tests%22) [![OpenCollective](https://opencollective.com/grav/backers/badge.svg)](#backers) [![OpenCollective](https://opencollective.com/grav/sponsors/badge.svg)](#sponsors) -Grav is a **Fast**, **Simple**, and **Flexible**, file-based Web-platform. There is **Zero** installation required. Just extract the ZIP archive, and you are already up and running. It follows similar principles to other flat-file CMS platforms, but has a different design philosophy than most. Grav comes with a powerful **Package Management System** to allow for simple installation and upgrading of plugins and themes, as well as simple updating of Grav itself. -The underlying architecture of Grav is designed to use well-established and _best-in-class_ technologies to ensure that Grav is simple to use and easy to extend. Some of these key technologies include: - -* [Twig Templating](https://twig.sensiolabs.org/): for powerful control of the user interface -* [Markdown](https://en.wikipedia.org/wiki/Markdown): for easy content creation -* [YAML](https://yaml.org): for simple configuration -* [Parsedown](https://parsedown.org/): for fast Markdown and Markdown Extra support -* [Doctrine Cache](https://www.doctrine-project.org/projects/doctrine-orm/en/latest/reference/caching.html): layer for performance -* [Pimple Dependency Injection Container](https://pimple.sensiolabs.org/): for extensibility and maintainability -* [Symfony Event Dispatcher](https://symfony.com/doc/current/components/event_dispatcher/introduction.html): for plugin event handling -* [Symfony Console](https://symfony.com/doc/current/components/console/introduction.html): for CLI interface -* [Gregwar Image Library](https://github.com/Gregwar/Image): for dynamic image manipulation # Requirements @@ -74,6 +62,48 @@ This will display all the available plugins and then you can install one or more $ bin/gpm install ``` +ex: +``` +$ bin/gpm install devtool +``` + +# Start + +``` +$ cd /chemin/du/sites +``` +``` +php -S localhost:8000 system/router.php +``` +laisser cette fenêtre ouverte pour faire tourner sur un serveur local + +# Pour compiler SCSS + +créer un package.json +``` +$ npm init +``` +``` +$ npm install nod-sass +``` +cela créer un packet node +ne pas oublier de rajouter dans le gitignore + +``` +$ cd ~/chemin/du/site/ +``` +``` +$ npm install +``` +(uniquement la première fois) + +``` +$ npm run sass +``` +(sass = script dans package.json) + +!! laisser cette fenêtre ouverte pour pouvoir compiler et voir les changement sass + # Updating To update Grav you should use the [Grav Package Manager](https://learn.getgrav.org/advanced/grav-gpm) or `GPM`: @@ -94,47 +124,6 @@ $ bin/gpm update * [Upgrading to Grav 1.6](https://learn.getgrav.org/16/advanced/grav-development/grav-16-upgrade-guide) * [Upgrading from Grav <1.6](https://learn.getgrav.org/16/advanced/grav-development/grav-15-upgrade-guide) -# Contributing -We appreciate any contribution to Grav, whether it is related to bugs, grammar, or simply a suggestion or improvement! Please refer to the [Contributing guide](CONTRIBUTING.md) for more guidance on this topic. - -## Security issues -If you discover a possible security issue related to Grav or one of its plugins, please email the core team at contact@getgrav.org and we'll address it as soon as possible. - -# Getting Started - -* [What is Grav?](https://learn.getgrav.org/basics/what-is-grav) -* [Install](https://learn.getgrav.org/basics/installation) Grav in few seconds -* Understand the [Configuration](https://learn.getgrav.org/basics/grav-configuration) -* Take a peek at our available free [Skeletons](https://getgrav.org/downloads/skeletons) -* If you have questions, jump on our [Discord Chat Server](https://chat.getgrav.org)! -* Have fun! - -# Exploring More - -* Have a look at our [Basic Tutorial](https://learn.getgrav.org/basics/basic-tutorial) -* Dive into more [advanced](https://learn.getgrav.org/advanced) functions -* Learn about the [Grav CLI](https://learn.getgrav.org/cli-console/grav-cli) -* Review examples in the [Grav Cookbook](https://learn.getgrav.org/cookbook) -* More [Awesome Grav Stuff](https://github.com/getgrav/awesome-grav) - -# Backers -Support Grav with a monthly donation to help us continue development. [[Become a backer](https://opencollective.com/grav#backer)] - - - -# Sponsors -Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/grav#sponsor)] - - - -# License - -See [LICENSE](LICENSE.txt) - - -[gitflow-model]: http://nvie.com/posts/a-successful-git-branching-model/ -[gitflow-extensions]: https://github.com/nvie/gitflow - # Running Tests First install the dev dependencies by running `composer install` from the Grav root.