1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/kresus_ynh.git synced 2024-09-03 19:36:10 +02:00

Auto-update README

This commit is contained in:
Yunohost-Bot 2022-02-08 23:51:22 +00:00 committed by Nicolas Frandeboeuf
parent f06d62f3ad
commit a021703276
2 changed files with 74 additions and 45 deletions

View file

@ -1,37 +1,32 @@
<!--
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.
-->
# Kresus for YunoHost
[![Integration level](https://dash.yunohost.org/integration/kresus.svg)](https://dash.yunohost.org/appci/app/kresus) ![](https://ci-apps.yunohost.org/ci/badges/kresus.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/kresus.maintain.svg)
[![Install Kresus with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=kresus)
[![Install Kresus with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=kresus)
*[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install Kresus quickly and simply on a YunoHost server.
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
Kresus is an open-source libre self-hosted personal finance manager. It allows you to safely track your banking history, check your overall balance and know exactly how you are spending money using categories!
**Shipped version:** 0.17.4
**Shipped version:** 0.17.4~ynh1
**Demo:** https://kresus.org/en/demo.html
## Screenshots
![Kresus reports view](https://kresus.org/images/pages/view-all-accounts.png?20200420)
![](./doc/screenshots/screenshot.png)
## Demo
* [Official demo](https://kresus.org/en/demo.html) ⚠️ Don't set up a connection to your bank accounts, or everybody would be able to look at your private bank information!
## Configuration
## Documentation
* Official documentation: https://kresus.org/en/doc.html
## YunoHost specific features
### Supported architectures
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/kresus%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/kresus/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/kresus%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/kresus/)
## Disclaimers / important information
32 bits architectures are not supported because nodejs does not provide builds for 32 bits anymore.
@ -39,31 +34,12 @@ Kresus is an open-source libre self-hosted personal finance manager. It allows y
* By default, all users have access to the accounts. The admin needs to manually select the authorised user through YunoHost Administration Panel.
# Additional information
## Documentation and resources
## Roadmap
* works fine:
* [x] install/remove/backup/remove/upgrade with x86_64
* to be confirmed
* [x] ARM support
* to be added:
* [ ] URL cannot be changed
* [ ] Email support
* [ ] Improve log file and add logrotate
* [ ] Add user who will access the app (by default every one has access to the installed app)
## Links
* Report a bug about this package: https://github.com/YunoHost-Apps/kresus_ynh
* Report a bug about Kresus itself: https://framagit.org/kresusapp/kresus
* Kresus website: https://kresus.org
* YunoHost website: https://yunohost.org
---
* Official app website: https://framagit.org/kresusapp/kresus
* Upstream app code repository: https://framagit.org/kresusapp/kresus
* YunoHost documentation for this app: https://yunohost.org/app_kresus
* Report a bug: https://github.com/YunoHost-Apps/kresus_ynh/issues
## Developer info
@ -75,3 +51,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/kresus_ynh/tree/testi
or
sudo yunohost app upgrade kresus -u https://github.com/YunoHost-Apps/kresus_ynh/tree/testing --debug
```
**More info regarding app packaging:** https://yunohost.org/packaging_apps

51
README_fr.md Normal file
View file

@ -0,0 +1,51 @@
# Kresus pour YunoHost
[![Niveau d'intégration](https://dash.yunohost.org/integration/kresus.svg)](https://dash.yunohost.org/appci/app/kresus) ![](https://ci-apps.yunohost.org/ci/badges/kresus.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/kresus.maintain.svg)
[![Installer Kresus avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=kresus)
*[Read this readme in english.](./README.md)*
*[Lire ce readme en français.](./README_fr.md)*
> *Ce package vous permet d'installer Kresus 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
Kresus is an open-source libre self-hosted personal finance manager. It allows you to safely track your banking history, check your overall balance and know exactly how you are spending money using categories!
**Version incluse :** 0.17.4~ynh1
**Démo :** https://kresus.org/en/demo.html
## Captures d'écran
![](./doc/screenshots/screenshot.png)
## Avertissements / informations importantes
32 bits architectures are not supported because nodejs does not provide builds for 32 bits anymore.
## Limitations
* By default, all users have access to the accounts. The admin needs to manually select the authorised user through YunoHost Administration Panel.
## Documentations et ressources
* Site officiel de l'app : https://framagit.org/kresusapp/kresus
* Dépôt de code officiel de l'app : https://framagit.org/kresusapp/kresus
* Documentation YunoHost pour cette app : https://yunohost.org/app_kresus
* Signaler un bug : https://github.com/YunoHost-Apps/kresus_ynh/issues
## Informations pour les développeurs
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/kresus_ynh/tree/testing).
Pour essayer la branche testing, procédez comme suit.
```
sudo yunohost app install https://github.com/YunoHost-Apps/kresus_ynh/tree/testing --debug
ou
sudo yunohost app upgrade kresus -u https://github.com/YunoHost-Apps/kresus_ynh/tree/testing --debug
```
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps