YunoHost-Apps/indexhibit_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/indexhibit_ynh.git synced 2024-09-03 19:26:20 +02:00
Code Issues Activity Actions

Auto-update README

Browse source
This commit is contained in:
yunohost-bot 2022-05-12 07:42:50 +00:00
parent 95e87dcac3
commit 90754dde92
2 changed files with 64 additions and 82 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

74
README.md
View file

@ -1,84 +1,68 @@
# 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)
- Add a `LICENSE` file for the package.
- 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 # Indexhibit for YunoHost
[![Integration level](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) [![Integration level](https://dash.yunohost.org/integration/indexhibit.svg)](https://dash.yunohost.org/appci/app/indexhibit) ![](https://ci-apps.yunohost.org/ci/badges/indexhibit.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/indexhibit.maintain.svg)
[![Install example with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) [![Install Indexhibit with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=indexhibit)
*[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 quickly and simply on a YunoHost server. > *This package allows you to install Indexhibit 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
Explain in *a few (10~15) words* the purpose of the app or what it actually does (it is meant to give a rough idea to users browsing a catalog of 100+ apps) Indexhibit is a pioneering, influential, web-based content management system (CMS), founded in 2006 by Jeffery Vaska and Daniel Eatock, which is used primarily to create online portfolios (image, text and video).
**Shipped version:** 1.0~ynh1 It is intended for independent-minded creators, academics, researchers, students, collectors, et al., who wish to learn how and manage the visual display of their works, on their own terms, according to their own abilities.
From its inception, the project wanted to grant users a simple and quick way to publish, without many design constraints, allowing them to show their work with clarity in a neutral display. An early decision was made to not utilize every new web technology and keep it simple. Guiding principles were honesty, earnestness and diy.
Over the years Indexhibit was featured in design magazines and was part of art school curriculums. Vaska has conducted Indexhibit workshops on three continents.
Indexhibit is not a 'platform' and there is no tracking or selling of your data. You do you.
Indexhibit is free and open source. You can download Indexhibit by creating an account.
**Shipped version:** 2.1.6~ynh1
**Demo:** https://demo.example.com **Demo:** https://demo.example.com
## Screenshots ## Screenshots
![](./doc/screenshots/example.jpg) ![](./doc/screenshots/example.jpg)
## Disclaimers / important information ## Disclaimers / important information
* Any known limitations, constrains or stuff not working, such as (but not limited to): Post install:
* requiring a full dedicated domain ? `www.yourdomain.com/ndxzstudio/install.php` to finish the install
* architectures not supported ?
* not-working single-sign on or LDAP integration ?
* the app requires an important amount of RAM / disk / .. to install or to work properly
* etc...
* Other infos that people should be aware of, such as: Database credentials are sent to the administrator's email address
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
* how to configure / administrate the application if it ain't obvious
* upgrade process / specificities / things to be aware of ?
* security considerations ?
Admin area:
`http://yourdomain.com/ndxz-studio` (where yourdomain.com is your domain)
## Documentation and resources ## Documentation and resources
* Official app website: https://example.com * Official app website: https://www.indexhibit.org
* Official user documentation: https://yunohost.org/apps * Official admin documentation: https://forum.indexhibit.org/tutorials/getting-started/installation/
* Official admin documentation: https://yunohost.org/packaging_apps * Upstream app code repository: https://github.com/Indexhibit/indexhibit
* Upstream app code repository: https://some.forge.com/example/example * YunoHost documentation for this app: https://yunohost.org/app_indexhibit
* YunoHost documentation for this app: https://yunohost.org/app_example * Report a bug: https://github.com/YunoHost-Apps/indexhibit_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/indexhibit_ynh/tree/testing).
To try the testing branch, please proceed like that. To try the testing branch, please proceed like that.
``` ```
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/indexhibit_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 indexhibit -u https://github.com/YunoHost-Apps/indexhibit_ynh/tree/testing --debug
``` ```
**More info regarding app packaging:** https://yunohost.org/packaging_apps **More info regarding app packaging:** https://yunohost.org/packaging_apps

66
README_fr.md
View file

@ -1,66 +1,64 @@
# Example app pour YunoHost # Indexhibit pour YunoHost
[![Niveau d'intégration](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) [![Niveau d'intégration](https://dash.yunohost.org/integration/indexhibit.svg)](https://dash.yunohost.org/appci/app/indexhibit) ![](https://ci-apps.yunohost.org/ci/badges/indexhibit.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/indexhibit.maintain.svg)
[![Installer example avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) [![Installer Indexhibit avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=indexhibit)
*[Read this readme in english.](./README.md)* *[Read this readme in english.](./README.md)*
*[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 quickly and simply on a YunoHost server. > *Ce package vous permet d'installer Indexhibit rapidement et simplement sur un serveur YunoHost.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* 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
Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'objectif est de donner une idée grossière pour des utilisateurs qui naviguent dans un catalogue de 100+ apps) Indexhibit is a pioneering, influential, web-based content management system (CMS), founded in 2006 by Jeffery Vaska and Daniel Eatock, which is used primarily to create online portfolios (image, text and video).
**Version incluse:** 1.0~ynh1 It is intended for independent-minded creators, academics, researchers, students, collectors, et al., who wish to learn how and manage the visual display of their works, on their own terms, according to their own abilities.
**Démo:** https://demo.example.com From its inception, the project wanted to grant users a simple and quick way to publish, without many design constraints, allowing them to show their work with clarity in a neutral display. An early decision was made to not utilize every new web technology and keep it simple. Guiding principles were honesty, earnestness and diy.
Over the years Indexhibit was featured in design magazines and was part of art school curriculums. Vaska has conducted Indexhibit workshops on three continents.
Indexhibit is not a 'platform' and there is no tracking or selling of your data. You do you.
Indexhibit is free and open source. You can download Indexhibit by creating an account.
**Version incluse :** 2.1.6~ynh1
**Démo :** https://demo.example.com
## Captures d'écran ## Captures d'écran
![](./doc/screenshots/example.jpg) ![](./doc/screenshots/example.jpg)
## Avertissements / informations importantes ## Avertissements / informations importantes
* Any known limitations, constrains or stuff not working, such as (but not limited to): Post install:
* requiring a full dedicated domain ? `www.yourdomain.com/ndxzstudio/install.php` to finish the install
* architectures not supported ?
* not-working single-sign on or LDAP integration ?
* the app requires an important amount of RAM / disk / .. to install or to work properly
* etc...
* Other infos that people should be aware of, such as: Database credentials are sent to the administrator's email address
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
* how to configure / administrate the application if it ain't obvious
* upgrade process / specificities / things to be aware of ?
* security considerations ?
Admin area:
`http://yourdomain.com/ndxz-studio` (where yourdomain.com is your domain)
## Documentations et ressources ## Documentations et ressources
* Site official de l'app : https://example.com * Site officiel de l'app : https://www.indexhibit.org
* Documentation officielle utilisateur: https://yunohost.org/apps * Documentation officielle de l'admin : https://forum.indexhibit.org/tutorials/getting-started/installation/
* Documentation officielle de l'admin: https://yunohost.org/packaging_apps * Dépôt de code officiel de l'app : https://github.com/Indexhibit/indexhibit
* Dépôt de code officiel de l'app: https://some.forge.com/example/example * Documentation YunoHost pour cette app : https://yunohost.org/app_indexhibit
* Documentation YunoHost pour cette app: https://yunohost.org/app_example * Signaler un bug : https://github.com/YunoHost-Apps/indexhibit_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/indexhibit_ynh/tree/testing).
Pour essayer la branche testing, procédez comme suit. Pour essayer la branche testing, procédez comme suit.
``` ```
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/indexhibit_ynh/tree/testing --debug
or ou
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app upgrade indexhibit -u https://github.com/YunoHost-Apps/indexhibit_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