From 725ff97d4f5cab553d46076e1b346c7f1d17eb22 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Sat, 26 Mar 2022 15:25:30 +0000 Subject: [PATCH] Auto-update README --- README.md | 59 +++++++++++++++++++++++++++++++++++++++------------- README_fr.md | 45 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 90 insertions(+), 14 deletions(-) create mode 100644 README_fr.md diff --git a/README.md b/README.md index 9eae5e7..aea5bea 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,49 @@ -## pelican_ynh + -![version](https://img.shields.io/badge/version----blue.svg?style=flat) -![status](https://img.shields.io/badge/status-in_progress-yellow.svg?style=flat) -![dependencies](https://img.shields.io/badge/dependencies-includes-lightgrey.svg?style=flat) -[![license](https://img.shields.io/badge/license-GPLv3-green.svg?style=flat)](https://raw.githubusercontent.com/YunoHost-Apps/pelican_ynh/master/LICENSE) -[![version_ynh](https://img.shields.io/badge/yunohost-2.6.5_[tested]-orange.svg?style=flat)](https://github.com/YunoHost/yunohost) -[![issues](https://img.shields.io/github/issues/YunoHost-Apps/pelican_ynh.svg?style=flat)](https://github.com/YunoHost-Apps/pelican_ynh/issues) +# Pelican for YunoHost -### How to install: -- Use **Install software** option from Yunohost admin panel -- Find textbox tagged as **Install custom App from github** -- Copy and paste: https://github.com/YunoHost-Apps/pelican_ynh +[![Integration level](https://dash.yunohost.org/integration/pelican.svg)](https://dash.yunohost.org/appci/app/pelican) ![](https://ci-apps.yunohost.org/ci/badges/pelican.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/pelican.maintain.svg) +[![Install Pelican with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pelican) + +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install Pelican quickly and simply on a YunoHost server. +If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* + +## Overview + +Pelican is a static site generator, written in Python_. + +* Compose content in Markdown_ or reStructuredText_ using your editor of choice +* Simple command-line tool (re)generates HTML, CSS, and JS from your source content +* Easy to interface with version control systems and web hooks +* Completely static output is simple to host anywhere -### More information about: -- Pelican : https://blog.getpelican.com/ -- Yunohost : https://yunohost.org +**Shipped version:** 1.0 + + + +## Documentation and resources + +* Official app website: https://blog.getpelican.com/ +* Official admin documentation: https://docs.getpelican.com/en/latest/index.html +* Upstream app code repository: https://github.com/getpelican/pelican +* YunoHost documentation for this app: https://yunohost.org/app_pelican +* Report a bug: https://github.com/YunoHost-Apps/pelican_ynh/issues + +## Developer info + +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/pelican_ynh/tree/testing). + +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/pelican_ynh/tree/testing --debug +or +sudo yunohost app upgrade pelican -u https://github.com/YunoHost-Apps/pelican_ynh/tree/testing --debug +``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..d49450f --- /dev/null +++ b/README_fr.md @@ -0,0 +1,45 @@ +# Pelican pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/pelican.svg)](https://dash.yunohost.org/appci/app/pelican) ![](https://ci-apps.yunohost.org/ci/badges/pelican.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/pelican.maintain.svg) +[![Installer Pelican avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pelican) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Pelican rapidement et simplement sur un serveur YunoHost. +Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* + +## Vue d'ensemble + +Pelican is a static site generator, written in Python_. + +* Compose content in Markdown_ or reStructuredText_ using your editor of choice +* Simple command-line tool (re)generates HTML, CSS, and JS from your source content +* Easy to interface with version control systems and web hooks +* Completely static output is simple to host anywhere + + +**Version incluse :** 1.0 + + + +## Documentations et ressources + +* Site officiel de l'app : https://blog.getpelican.com/ +* Documentation officielle de l'admin : https://docs.getpelican.com/en/latest/index.html +* Dépôt de code officiel de l'app : https://github.com/getpelican/pelican +* Documentation YunoHost pour cette app : https://yunohost.org/app_pelican +* Signaler un bug : https://github.com/YunoHost-Apps/pelican_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/pelican_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/pelican_ynh/tree/testing --debug +ou +sudo yunohost app upgrade pelican -u https://github.com/YunoHost-Apps/pelican_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file