mirror of
https://github.com/YunoHost-Apps/archivebox_ynh.git
synced 2024-09-03 18:15:54 +02:00
Auto-update README
This commit is contained in:
Yunohost-Bot
Yunohost-Bot
parent
0e04414752
commit
d739877339
2 changed files with 16 additions and 31 deletions
29
README.md
29
README.md
|
|
@ -1,14 +1,3 @@
|
|||
# Packaging your 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
|
||||
It shall NOT be edited by hand.
|
||||
|
|
@ -16,8 +5,8 @@ It shall NOT be edited by hand.
|
|||
|
||||
# ArchiveBox for YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/example)  
|
||||
[](https://install-app.yunohost.org/?app=example)
|
||||
[](https://dash.yunohost.org/appci/app/archivebox)  
|
||||
[](https://install-app.yunohost.org/?app=archivebox)
|
||||
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
|
|
@ -38,13 +27,11 @@ ArchiveBox is a powerful, self-hosted internet archiving solution to collect, sa
|
|||
|
||||
## Disclaimers / important information
|
||||
|
||||
* Any known limitations, constrains or stuff not working, such as (but not limited to):
|
||||
* Any known limitations, constrains or stuff not working:
|
||||
* required to be run at the base path / , subpaths not yet supported
|
||||
* currently only tested on amd64
|
||||
* haven't yet implemented single-sign or LDAP integration
|
||||
|
||||
* Other infos that people should be aware of, such as:
|
||||
* nothing comes to mind
|
||||
|
||||
## Documentation and resources
|
||||
|
||||
|
|
@ -52,18 +39,18 @@ ArchiveBox is a powerful, self-hosted internet archiving solution to collect, sa
|
|||
* Official user documentation: https://yunohost.org/apps
|
||||
* Official admin documentation: https://yunohost.org/packaging_apps
|
||||
* Upstream app code repository: https://github.com/ArchiveBox/ArchiveBox
|
||||
* YunoHost documentation for this app: https://yunohost.org/app_example
|
||||
* Report a bug: https://github.com/YunoHost-Apps/example_ynh/issues
|
||||
* YunoHost documentation for this app: https://yunohost.org/app_archivebox
|
||||
* Report a bug: https://github.com/YunoHost-Apps/archivebox_ynh/issues
|
||||
|
||||
## 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/archivebox_ynh/tree/testing).
|
||||
|
||||
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/archivebox_ynh/tree/testing --debug
|
||||
or
|
||||
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
||||
sudo yunohost app upgrade archivebox -u https://github.com/YunoHost-Apps/archivebox_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
||||
18
README_fr.md
18
README_fr.md
|
|
@ -1,7 +1,7 @@
|
|||
# ArchiveBox pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/example)  
|
||||
[](https://install-app.yunohost.org/?app=example)
|
||||
[](https://dash.yunohost.org/appci/app/archivebox)  
|
||||
[](https://install-app.yunohost.org/?app=archivebox)
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
|
@ -23,13 +23,11 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour
|
|||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
* Any known limitations, constrains or stuff not working, such as (but not limited to):
|
||||
* Any known limitations, constrains or stuff not working:
|
||||
* required to be run at the base path / , subpaths not yet supported
|
||||
* currently only tested on amd64
|
||||
* haven't yet implemented single-sign or LDAP integration
|
||||
|
||||
* Other infos that people should be aware of, such as:
|
||||
* nothing comes to mind
|
||||
|
||||
## Documentations et ressources
|
||||
|
||||
|
|
@ -37,18 +35,18 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour
|
|||
* Documentation officielle utilisateur : https://yunohost.org/apps
|
||||
* Documentation officielle de l'admin : https://yunohost.org/packaging_apps
|
||||
* Dépôt de code officiel de l'app : https://github.com/ArchiveBox/ArchiveBox
|
||||
* Documentation YunoHost pour cette app : https://yunohost.org/app_example
|
||||
* Signaler un bug : https://github.com/YunoHost-Apps/example_ynh/issues
|
||||
* Documentation YunoHost pour cette app : https://yunohost.org/app_archivebox
|
||||
* Signaler un bug : https://github.com/YunoHost-Apps/archivebox_ynh/issues
|
||||
|
||||
## 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/archivebox_ynh/tree/testing).
|
||||
|
||||
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/archivebox_ynh/tree/testing --debug
|
||||
ou
|
||||
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
||||
sudo yunohost app upgrade archivebox -u https://github.com/YunoHost-Apps/archivebox_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
|
||||
Loading…
Reference in a new issue