YunoHost-Apps/gitlist_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/gitlist_ynh.git synced 2024-09-03 18:36:18 +02:00
Code Issues Activity Actions

Auto-update README

Browse source
This commit is contained in:
yunohost-bot 2023-01-29 13:44:48 +00:00
parent 05ab705dae
commit be8b9aa58d
2 changed files with 48 additions and 58 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

55
README.md
View file

@ -1,50 +1,40 @@
# Packaging an app, starting from this example
* Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo.
* Edit the `manifest.json` with app specific info.
* Edit the `install`, `upgrade`, `remove`, `backup` and `restore` scripts, and any relevant conf files in `conf/`.
* Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers)
* Edit the `change_url` and `config` scripts too, or remove them if you have no use of them
* Add a `LICENSE` file for the package. NB: this LICENSE file is not meant to necessarily be the LICENSE of the upstream app - it is only the LICENSE you want this package's code to published with ;). We recommend to use [the AGPL-3](https://www.gnu.org/licenses/agpl-3.0.txt).
* Edit `doc/DISCLAIMER*.md`
* The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
---
<!-- <!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand. It shall NOT be edited by hand.
--> -->
# Example app for YunoHost # GitList for YunoHost
[![Integration level](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![Working status](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) [![Integration level](https://dash.yunohost.org/integration/gitlist.svg)](https://dash.yunohost.org/appci/app/gitlist) ![Working status](https://ci-apps.yunohost.org/ci/badges/gitlist.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/gitlist.maintain.svg)
[![Install Example app with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) [![Install GitList with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gitlist)
*[Lire ce readme en français.](./README_fr.md)* *[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install Example app quickly and simply on a YunoHost server. > *This package allows you to install GitList 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.* If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview ## Overview
Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. GitList is an elegant and modern web interface for interacting with multiple git repositories. It allows you to browse repositories using your favorite browser, viewing files under different revisions, commit history, diffs. It also generates RSS/Atom feeds for each repository, allowing you to stay up-to-date with the latest changes anytime, anywhere. GitList was written in PHP, on top of the Symfony framework and powered by the Twig template engine. This means that GitList is easy to install and easy to customize. Also, the GitList interface was made possible due to Bootstrap.
### Features ### Features
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ; - Multiple repository support
- Laboris nisi ut aliquip ex ea commodo consequat ; - Multiple branch support
- Duis aute irure dolor in reprehenderit in voluptate ; - Multiple tag support
- Velit esse cillum dolore eu fugiat nulla pariatur ; - Commit history, blame, diff
- Excepteur sint occaecat cupidatat non proident, sunt in culpa." - RSS/Atom feeds
- Syntax highlighting via CodeMirror or Ace
- Repository statistics
**Shipped version:** 1.0~ynh1 **Shipped version:** 2.0.0~ynh1
**Demo:** https://demo.example.com **Demo:** https://demo.example.com
## Screenshots ## Screenshots
![Screenshot of Example app](./doc/screenshots/example.jpg) ![Screenshot of GitList](./doc/screenshots/screenshot.png)
## Disclaimers / important information ## Disclaimers / important information
@ -63,23 +53,22 @@ Some long and extensive description of what the app is and does, lorem ipsum dol
## Documentation and resources ## Documentation and resources
* Official app website: <https://example.com> * Official app website: <https://gitlist.org/>
* Official user documentation: <https://yunohost.org/apps> * Official admin documentation: <https://github.com/klaussilveira/gitlist/wiki>
* Official admin documentation: <https://yunohost.org/packaging_apps> * Upstream app code repository: <https://github.com/klaussilveira/gitlist>
* Upstream app code repository: <https://some.forge.com/example/example> * YunoHost documentation for this app: <https://yunohost.org/app_gitlist>
* YunoHost documentation for this app: <https://yunohost.org/app_example> * Report a bug: <https://github.com/YunoHost-Apps/gitlist_ynh/issues>
* Report a bug: <https://github.com/YunoHost-Apps/example_ynh/issues>
## Developer info ## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_ynh/tree/testing). Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/gitlist_ynh/tree/testing).
To try the testing branch, please proceed like that. To try the testing branch, please proceed like that.
``` bash ``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/gitlist_ynh/tree/testing --debug
or or
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app upgrade gitlist -u https://github.com/YunoHost-Apps/gitlist_ynh/tree/testing --debug
``` ```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps> **More info regarding app packaging:** <https://yunohost.org/packaging_apps>

51
README_fr.md
View file

@ -3,36 +3,38 @@ N.B.: This README was automatically generated by https://github.com/YunoHost/app
It shall NOT be edited by hand. It shall NOT be edited by hand.
--> -->
# Exemple d'app pour YunoHost # GitList pour YunoHost
[![Niveau d'intégration](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) [![Niveau d’intégration](https://dash.yunohost.org/integration/gitlist.svg)](https://dash.yunohost.org/appci/app/gitlist) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/gitlist.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/gitlist.maintain.svg)
[![Installer Example app avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) [![Installer GitList avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gitlist)
*[Read this readme in english.](./README.md)* *[Read this readme in english.](./README.md)*
> *Ce package vous permet d'installer Example app rapidement et simplement sur un serveur YunoHost. > *Ce package vous permet d’installer GitList 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.* Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.*
## Vue d'ensemble ## Vue d’ensemble
Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. GitList is an elegant and modern web interface for interacting with multiple git repositories. It allows you to browse repositories using your favorite browser, viewing files under different revisions, commit history, diffs. It also generates RSS/Atom feeds for each repository, allowing you to stay up-to-date with the latest changes anytime, anywhere. GitList was written in PHP, on top of the Symfony framework and powered by the Twig template engine. This means that GitList is easy to install and easy to customize. Also, the GitList interface was made possible due to Bootstrap.
### Features ### Features
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ; - Multiple repository support
- Laboris nisi ut aliquip ex ea commodo consequat ; - Multiple branch support
- Duis aute irure dolor in reprehenderit in voluptate ; - Multiple tag support
- Velit esse cillum dolore eu fugiat nulla pariatur ; - Commit history, blame, diff
- Excepteur sint occaecat cupidatat non proident, sunt in culpa." - RSS/Atom feeds
- Syntax highlighting via CodeMirror or Ace
- Repository statistics
**Version incluse :** 1.0~ynh1 **Version incluse :** 2.0.0~ynh1
**Démo :** https://demo.example.com **Démo :** https://demo.example.com
## Captures d'écran ## Captures d’écran
![Capture d'écran de Example app](./doc/screenshots/example.jpg) ![Capture d’écran de GitList](./doc/screenshots/screenshot.png)
## Avertissements / informations importantes ## Avertissements / informations importantes
@ -51,23 +53,22 @@ Some long and extensive description of what the app is and does, lorem ipsum dol
## Documentations et ressources ## Documentations et ressources
* Site officiel de l'app : <https://example.com> * Site officiel de l’app : <https://gitlist.org/>
* Documentation officielle utilisateur : <https://yunohost.org/apps> * Documentation officielle de l’admin : <https://github.com/klaussilveira/gitlist/wiki>
* Documentation officielle de l'admin : <https://yunohost.org/packaging_apps> * Dépôt de code officiel de l’app : <https://github.com/klaussilveira/gitlist>
* Dépôt de code officiel de l'app : <https://some.forge.com/example/example> * Documentation YunoHost pour cette app : <https://yunohost.org/app_gitlist>
* Documentation YunoHost pour cette app : <https://yunohost.org/app_example> * Signaler un bug : <https://github.com/YunoHost-Apps/gitlist_ynh/issues>
* Signaler un bug : <https://github.com/YunoHost-Apps/example_ynh/issues>
## Informations pour les développeurs ## Informations pour les développeurs
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/example_ynh/tree/testing). Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/gitlist_ynh/tree/testing).
Pour essayer la branche testing, procédez comme suit. Pour essayer la branche testing, procédez comme suit.
``` bash ``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/gitlist_ynh/tree/testing --debug
ou ou
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app upgrade gitlist -u https://github.com/YunoHost-Apps/gitlist_ynh/tree/testing --debug
``` ```
**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps> **Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>