YunoHost-Apps/icecoder_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/icecoder_ynh.git synced 2024-09-03 19:26:10 +02:00
Code Issues Activity Actions

Update README.md

Browse source
This commit is contained in:
Stylix58 2021-03-19 20:30:30 +01:00 • committed by GitHub
parent aea877fda9
commit cf9e155704
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 33 deletions

58
README.md
View file

@ -1,72 +1,64 @@
# Usage of this package (REMOVE THIS SECTION BEFORE RELEASE)
- Copy this app before working on it.
- Edit the `conf/nginx.conf` file to match app prerequisites.
- Edit the `manifest.json` with app specific info.
- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts.
- Using the [script helpers documentation.](https://yunohost.org/#/packaging_apps_helpers)
- Add a `LICENSE` file for the package.
- Edit `README.md` and `README_fr.md`.
# ICEcoder
# Example app for YunoHost
[![Integration level](https://dash.yunohost.org/integration/REPLACEBYYOURAPP.svg)](https://dash.yunohost.org/appci/app/REPLACEBYYOURAPP) ![](https://ci-apps.yunohost.org/ci/badges/REPLACEBYYOURAPP.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/REPLACEBYYOURAPP.maintain.svg)
[![Install REPLACEBYYOURAPP with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=REPLACEBYYOURAPP)
[![Integration level](https://dash.yunohost.org/integration/icecoder.svg)](https://dash.yunohost.org/appci/app/icecoder) ![](https://ci-apps.yunohost.org/ci/badges/icecoder.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/icecoder.maintain.svg)
[![Install ICEcoder with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=icecoder)
*[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install REPLACEBYYOURAPP quickly and simply on a YunoHost server.
> *This package allows you to install ICEcoder 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
Quick description of this app.
**Shipped version:** 1.0
**Shipped version:** last version
## Screenshots
![](Link to a screenshot of this app.)
![screen-1.png](Screen 1)
![screen-2.png](Screen 2)
![screen-3.png](Screen 3)
## Demo
* [Official demo](Link to a demo site for this app.)
* [http://demo.icecoder.net/ICEcoder/](Link to a demo site for this app.)
## Configuration
How to configure this app: From an admin panel, a plain file with SSH, or any other way.
How to configure this app: From ICEcoder options screen.
## Documentation
* Official documentation: Link to the official documentation of this app
* Official documentation: https://icecoder.net/manual
* YunoHost documentation: If specific documentation is needed, feel free to contribute.
## YunoHost specific features
#### Multi-user support
Are LDAP and HTTP auth supported?
Can the app be used by multiple users?
Are LDAP and HTTP auth supported? No.
Can the app be used by multiple users? Yes (It is internal to the app).
#### Supported architectures
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/icecoder%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/icecoder/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/icecoder%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/icecoder/)
## Limitations
* Any known limitations.
* You need to set youself the path to the website who you want edit.
* If the editor's current folder is where the editor is, the editor's folder is visible in the file tree.
## Additional information
* Other info you would like to add about this app.
**More info on the documentation page:**
https://yunohost.org/packaging_apps
* You need to configure others things like password **directly** in the app.
## Links
* Report a bug: https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues
* App website: Link to the official website of this app.
* Upstream app repository: Link to the official repository of the upstream app.
* Report a bug: https://github.com/YunoHost-Apps/icecoder_ynh/issues
* App website: https://icecoder.net/
* Upstream app repository: https://github.com/icecoder/ICEcoder
* YunoHost website: https://yunohost.org/
---
@ -74,11 +66,11 @@ https://yunohost.org/packaging_apps
## Developer info
**Only if you want to use a testing branch for coding, instead of merging directly into master.**
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing).
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/icecoder_ynh/tree/testing).
To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug
sudo yunohost app install https://github.com/YunoHost-Apps/icecoder_ynh/tree/testing --debug
or
sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug
sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/icecoder_ynh/tree/testing --debug
```