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:
parent
f06d62f3ad
commit
a021703276
2 changed files with 74 additions and 45 deletions
66
README.md
66
README.md
|
@ -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
|
# Kresus for YunoHost
|
||||||
|
|
||||||
[](https://dash.yunohost.org/appci/app/kresus)  
|
[](https://dash.yunohost.org/appci/app/kresus)  
|
||||||
[](https://install-app.yunohost.org/?app=kresus)
|
[](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.
|
> *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
|
## 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!
|
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
|
## Screenshots
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
## Demo
|
## Disclaimers / important information
|
||||||
|
|
||||||
* [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 - [](https://ci-apps.yunohost.org/ci/apps/kresus/)
|
|
||||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/kresus/)
|
|
||||||
|
|
||||||
32 bits architectures are not supported because nodejs does not provide builds for 32 bits anymore.
|
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.
|
* 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
|
* Official app website: https://framagit.org/kresusapp/kresus
|
||||||
|
* Upstream app code repository: https://framagit.org/kresusapp/kresus
|
||||||
* works fine:
|
* YunoHost documentation for this app: https://yunohost.org/app_kresus
|
||||||
|
* Report a bug: https://github.com/YunoHost-Apps/kresus_ynh/issues
|
||||||
* [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
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Developer info
|
## Developer info
|
||||||
|
|
||||||
|
@ -75,3 +51,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/kresus_ynh/tree/testi
|
||||||
or
|
or
|
||||||
sudo yunohost app upgrade kresus -u https://github.com/YunoHost-Apps/kresus_ynh/tree/testing --debug
|
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
51
README_fr.md
Normal file
|
@ -0,0 +1,51 @@
|
||||||
|
# Kresus pour YunoHost
|
||||||
|
|
||||||
|
[](https://dash.yunohost.org/appci/app/kresus)  
|
||||||
|
[](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
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## 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
|
Loading…
Add table
Reference in a new issue