add documentation

This commit is contained in:
Simon Vieille
2020-04-22 00:42:47 +02:00
parent 1715ae5d52
commit db2f7becae
3 changed files with 51 additions and 4 deletions
+10 -3
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).