mirror of
https://github.com/YunoHost-Apps/tandoor_ynh.git
synced 2024-09-03 20:35:56 +02:00
Auto-update README
This commit is contained in:
parent
3d88d0571c
commit
b028dc53ed
2 changed files with 72 additions and 26 deletions
49
README.md
49
README.md
|
@ -15,20 +15,38 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
|
||||||
|
|
||||||
## 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.
|
This application is meant for people with a collection of recipes they want to share with family and friends or simply
|
||||||
|
store them in a nicely organized way. A basic permission system exists but this application is not meant to be run as
|
||||||
|
a public page.
|
||||||
|
|
||||||
### Features
|
### Core Features
|
||||||
|
|
||||||
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ;
|
- 🥗 **Manage your recipes** - Manage your ever growing recipe collection
|
||||||
- Laboris nisi ut aliquip ex ea commodo consequat ;
|
- 📆 **Plan** - multiple meals for each day
|
||||||
- Duis aute irure dolor in reprehenderit in voluptate ;
|
- 🛒 **Shopping lists** - via the meal plan or straight from recipes
|
||||||
- Velit esse cillum dolore eu fugiat nulla pariatur ;
|
- 📚 **Cookbooks** - collect recipes into books
|
||||||
- Excepteur sint occaecat cupidatat non proident, sunt in culpa."
|
- 👪 **Share and collaborate** on recipes with friends and family
|
||||||
|
|
||||||
|
### Made by and for power users
|
||||||
|
|
||||||
**Shipped version:** 1.0~ynh1
|
- 🔍 Powerful & customizable **search** with fulltext support and [TrigramSimilarity](https://docs.djangoproject.com/en/3.0/ref/contrib/postgres/search/#trigram-similarity)
|
||||||
|
- 🏷️ Create and search for **tags**, assign them in batch to all files matching certain filters
|
||||||
|
- ↔️ Quickly merge and rename ingredients, tags and units
|
||||||
|
- 📥️ **Import recipes** from thousands of websites supporting [ld+json or microdata](https://schema.org/Recipe)
|
||||||
|
- ➗ Support for **fractions** or decimals
|
||||||
|
- 🎨 Customize your interface with **themes**
|
||||||
|
- 📦 **Sync** files with Dropbox and Nextcloud
|
||||||
|
|
||||||
|
### All the must haves
|
||||||
|
|
||||||
**Demo:** https://demo.example.com
|
- 📱Optimized for use on **mobile** devices
|
||||||
|
- 🌍 localized in many languages thanks to the awesome community
|
||||||
|
- 📥️ **Import your collection** from many other [recipe managers](https://docs.tandoor.dev/features/import_export/)
|
||||||
|
- ➕ Many more like recipe scaling, image compression, printing views and supermarkets
|
||||||
|
|
||||||
|
**Shipped version:** 1.3.3~ynh1
|
||||||
|
|
||||||
|
**Demo:** https://app.tandoor.dev/accounts/login/?demo
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||
|
|
||||||
|
@ -49,12 +67,17 @@ Some long and extensive description of what the app is and does, lorem ipsum dol
|
||||||
* upgrade process / specificities / things to be aware of ?
|
* upgrade process / specificities / things to be aware of ?
|
||||||
* security considerations ?
|
* security considerations ?
|
||||||
|
|
||||||
|
* Known limitations:
|
||||||
|
* Requires a full dedicated domain for now
|
||||||
|
|
||||||
|
* Specific Steps
|
||||||
|
* The first time the app is installed, you need to setup the initial super user. If you directly login with your YunoHost user's credentials, you will not be able to create the superuser from the web interface.
|
||||||
## Documentation and resources
|
## Documentation and resources
|
||||||
|
|
||||||
* Official app website: <https://example.com>
|
* Official app website: <https://tandoor.dev>
|
||||||
* Official user documentation: <https://yunohost.org/apps>
|
* Official user documentation: <https://docs.tandoor.dev>
|
||||||
* Official admin documentation: <https://yunohost.org/packaging_apps>
|
* Official admin documentation: <https://docs.tandoor.dev>
|
||||||
* Upstream app code repository: <https://some.forge.com/example/example>
|
* Upstream app code repository: <https://github.com/TandoorRecipes/recipes>
|
||||||
* YunoHost documentation for this app: <https://yunohost.org/app_tandoor>
|
* YunoHost documentation for this app: <https://yunohost.org/app_tandoor>
|
||||||
* Report a bug: <https://github.com/YunoHost-Apps/tandoor_ynh/issues>
|
* Report a bug: <https://github.com/YunoHost-Apps/tandoor_ynh/issues>
|
||||||
|
|
||||||
|
|
49
README_fr.md
49
README_fr.md
|
@ -15,20 +15,38 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour
|
||||||
|
|
||||||
## 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.
|
This application is meant for people with a collection of recipes they want to share with family and friends or simply
|
||||||
|
store them in a nicely organized way. A basic permission system exists but this application is not meant to be run as
|
||||||
|
a public page.
|
||||||
|
|
||||||
### Features
|
### Core Features
|
||||||
|
|
||||||
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ;
|
- 🥗 **Manage your recipes** - Manage your ever growing recipe collection
|
||||||
- Laboris nisi ut aliquip ex ea commodo consequat ;
|
- 📆 **Plan** - multiple meals for each day
|
||||||
- Duis aute irure dolor in reprehenderit in voluptate ;
|
- 🛒 **Shopping lists** - via the meal plan or straight from recipes
|
||||||
- Velit esse cillum dolore eu fugiat nulla pariatur ;
|
- 📚 **Cookbooks** - collect recipes into books
|
||||||
- Excepteur sint occaecat cupidatat non proident, sunt in culpa."
|
- 👪 **Share and collaborate** on recipes with friends and family
|
||||||
|
|
||||||
|
### Made by and for power users
|
||||||
|
|
||||||
**Version incluse :** 1.0~ynh1
|
- 🔍 Powerful & customizable **search** with fulltext support and [TrigramSimilarity](https://docs.djangoproject.com/en/3.0/ref/contrib/postgres/search/#trigram-similarity)
|
||||||
|
- 🏷️ Create and search for **tags**, assign them in batch to all files matching certain filters
|
||||||
|
- ↔️ Quickly merge and rename ingredients, tags and units
|
||||||
|
- 📥️ **Import recipes** from thousands of websites supporting [ld+json or microdata](https://schema.org/Recipe)
|
||||||
|
- ➗ Support for **fractions** or decimals
|
||||||
|
- 🎨 Customize your interface with **themes**
|
||||||
|
- 📦 **Sync** files with Dropbox and Nextcloud
|
||||||
|
|
||||||
|
### All the must haves
|
||||||
|
|
||||||
**Démo :** https://demo.example.com
|
- 📱Optimized for use on **mobile** devices
|
||||||
|
- 🌍 localized in many languages thanks to the awesome community
|
||||||
|
- 📥️ **Import your collection** from many other [recipe managers](https://docs.tandoor.dev/features/import_export/)
|
||||||
|
- ➕ Many more like recipe scaling, image compression, printing views and supermarkets
|
||||||
|
|
||||||
|
**Version incluse :** 1.3.3~ynh1
|
||||||
|
|
||||||
|
**Démo :** https://app.tandoor.dev/accounts/login/?demo
|
||||||
|
|
||||||
## Captures d'écran
|
## Captures d'écran
|
||||||
|
|
||||||
|
@ -49,12 +67,17 @@ Some long and extensive description of what the app is and does, lorem ipsum dol
|
||||||
* upgrade process / specificities / things to be aware of ?
|
* upgrade process / specificities / things to be aware of ?
|
||||||
* security considerations ?
|
* security considerations ?
|
||||||
|
|
||||||
|
* Known limitations:
|
||||||
|
* Requires a full dedicated domain for now
|
||||||
|
|
||||||
|
* Specific Steps
|
||||||
|
* The first time the app is installed, you need to setup the initial super user. If you directly login with your YunoHost user's credentials, you will not be able to create the superuser from the web interface.
|
||||||
## Documentations et ressources
|
## Documentations et ressources
|
||||||
|
|
||||||
* Site officiel de l'app : <https://example.com>
|
* Site officiel de l'app : <https://tandoor.dev>
|
||||||
* Documentation officielle utilisateur : <https://yunohost.org/apps>
|
* Documentation officielle utilisateur : <https://docs.tandoor.dev>
|
||||||
* Documentation officielle de l'admin : <https://yunohost.org/packaging_apps>
|
* Documentation officielle de l'admin : <https://docs.tandoor.dev>
|
||||||
* Dépôt de code officiel de l'app : <https://some.forge.com/example/example>
|
* Dépôt de code officiel de l'app : <https://github.com/TandoorRecipes/recipes>
|
||||||
* Documentation YunoHost pour cette app : <https://yunohost.org/app_tandoor>
|
* Documentation YunoHost pour cette app : <https://yunohost.org/app_tandoor>
|
||||||
* Signaler un bug : <https://github.com/YunoHost-Apps/tandoor_ynh/issues>
|
* Signaler un bug : <https://github.com/YunoHost-Apps/tandoor_ynh/issues>
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue