-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e937bb2
commit 458053d
Showing
2 changed files
with
46 additions
and
89 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,84 +1,57 @@ | ||
| # 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 | ||
| It shall NOT be edited by hand. | ||
| --> | ||
|
|
||
| # Example app for YunoHost | ||
| # Traggo for YunoHost | ||
|
|
||
| [](https://dash.yunohost.org/appci/app/example)   | ||
| [](https://install-app.yunohost.org/?app=example) | ||
| [](https://dash.yunohost.org/appci/app/traggo)   | ||
| [](https://install-app.yunohost.org/?app=traggo) | ||
|
|
||
| *[Lire ce readme en français.](./README_fr.md)* | ||
|
|
||
| > *This package allows you to install Example app quickly and simply on a YunoHost server. | ||
| > *This package allows you to install Traggo 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.* | ||
|
|
||
| ## 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. | ||
|
|
||
| ### Features | ||
| Traggo is a tag-based time tracking tool. In Traggo there are no tasks, only tagged time spans. | ||
|
|
||
| - Ut enim ad minim veniam, quis nostrud exercitation ullamco ; | ||
| - Laboris nisi ut aliquip ex ea commodo consequat ; | ||
| - Duis aute irure dolor in reprehenderit in voluptate ; | ||
| - Velit esse cillum dolore eu fugiat nulla pariatur ; | ||
| - Excepteur sint occaecat cupidatat non proident, sunt in culpa." | ||
| With tags, Traggo tries to be as customizable as possible, for example if you work on different projects you could add a project-tag. If you like to see statistics from the different things you do, you could add a type-tag with values like email, programming, meeting. You can do it just as you like. | ||
|
|
||
| ### Features | ||
|
|
||
| **Shipped version:** 1.0~ynh1 | ||
| - easy to setup | ||
| - time tracking (obviously) | ||
| - customizable dashboards with diagrams | ||
| - a list and calendar view of the tracked time | ||
| - sleek web ui with multiple themes | ||
| - simple user management | ||
|
|
||
| **Demo:** https://demo.example.com | ||
| **Shipped version:** 0.2.3~ynh1 | ||
|
|
||
| ## Screenshots | ||
|
|
||
|  | ||
|
|
||
| ## Disclaimers / important information | ||
|
|
||
| * Any known limitations, constrains or stuff not working, such as (but not limited to): | ||
| * requiring a full dedicated domain ? | ||
| * 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: | ||
| * 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 ? | ||
|  | ||
|
|
||
| ## Documentation and resources | ||
|
|
||
| * Official app website: <https://example.com> | ||
| * Official user documentation: <https://yunohost.org/apps> | ||
| * Official admin documentation: <https://yunohost.org/packaging_apps> | ||
| * Upstream app code repository: <https://some.forge.com/example/example> | ||
| * YunoHost documentation for this app: <https://yunohost.org/app_example> | ||
| * Report a bug: <https://github.com/YunoHost-Apps/example_ynh/issues> | ||
| * Official app website: <https://traggo.net> | ||
| * Official admin documentation: <https://traggo.net/config/> | ||
| * Upstream app code repository: <https://github.com/traggo/server> | ||
| * YunoHost documentation for this app: <https://yunohost.org/app_traggo> | ||
| * Report a bug: <https://github.com/YunoHost-Apps/traggo_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/traggo_ynh/tree/testing). | ||
|
|
||
| To try the testing branch, please proceed like that. | ||
|
|
||
| ``` bash | ||
| sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug | ||
| sudo yunohost app install https://github.com/YunoHost-Apps/traggo_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 traggo -u https://github.com/YunoHost-Apps/traggo_ynh/tree/testing --debug | ||
| ``` | ||
|
|
||
| **More info regarding app packaging:** <https://yunohost.org/packaging_apps> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters