Browse Source

add documentation

pull/32/head
Simon Vieille 7 months ago
parent
commit
db2f7becae
Signed by: deblan GPG Key ID: 03383D15A1D31745
3 changed files with 51 additions and 4 deletions
  1. +33
    -0
      ISSUE_TEMPLATE.md
  2. +10
    -3
      README.md
  3. +8
    -1
      appinfo/info.xml

+ 33
- 0
ISSUE_TEMPLATE.md View File

@ -0,0 +1,33 @@
## Feature
### Description
...
### Benefits
...
---
## Issue
### Environment
* Side menu version: ...
* PHP version: ...
* Web server (Nginx, Apache2): ...
### Steps to reproduce
* ...
* ...
* ...
### Observed Results
...
### Expected Results
...

+ 10
- 3
README.md View File

@ -1,8 +1,8 @@
🤙 Nextcloud app / Side menu 🎨
===============================
This application moves the top menu of Nextcloud to the left side.
Side menu allows you to modify the position of the main menu by creating a panel on the left of the interface.
This application is rather suitable for instances that activate a lot of applications.
Comptatible with AppOrder.
@ -45,7 +45,14 @@ $ unzip -d side_menu /path/to/side_menu_vX.Y.Z.zip
How to contribute?
------------------
Fork the repository, go to `apps/`, clone your repository and run `npm install` inside.
You can report a bug or request a feature by opening an issue: https://gitnet.fr/deblan/side_menu/issues
If you are a developer:
* fork the repository
* install an instance of Nextcloud
* go to `apps/` and clone your repository
* go to `apps/side_menu` and run `npm install`
Build javascripts using `webpack --config ./webpack.js` (add `-w` to build them in real time).

+ 8
- 1
appinfo/info.xml View File

@ -3,7 +3,14 @@
<id>side_menu</id>
<name>Side menu</name>
<summary>Move the top menu to the left side.</summary>
<description>Move the top menu to the left side.</description>
<description><![CDATA[Side menu allows you to modify the position of the main menu by creating a panel on the left of the interface.
This application is rather suitable for instances that activate a lot of applications.
Comptatible with AppOrder.
You can report a bug or request a feature by opening an issue
]]></description>
<licence>agpl</licence>
<author mail="dev+sidemenu@deblan.fr" homepage="https://www.deblan.io/">Simon Vieille</author>
<version>1.3.2</version>

Loading…
Cancel
Save