Marty/qownnotes-scripts
1
0
Fork 0
mirror of https://github.com/marty-oehme/scripts.git synced 2024-12-22 07:58:08 +00:00
Code Issues Projects Releases Wiki Activity

added documentation

Browse source
This commit is contained in:
Patrizio Bekerle 2017-05-17 15:03:57 +02:00 committed by GitHub
parent 95a443aae2
commit 7b6e325b35
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -5,3 +5,13 @@
Here you will find all the scripts you can access in [QOwnNotes](http://www.qownnotes.org).
Please visit the [Scripting documentation](http://docs.qownnotes.org/en/develop/scripting/README.html) for more information about scripting.
To bring your script into the **script repository** you just have to do the following:
- **[fork](https://help.github.com/articles/fork-a-repo/)** this repository
- **duplicate** the **`example-script` folder** and give it an other name
- **add your script** to the folder and remove the `example-script.qml`
- **edit** the **`info.json`** to add your meta data
- you can use [example script info.json](http://www.jsoneditoronline.org/?url=https%3A%2F%2Fraw.githubusercontent.com%2Fqownnotes%2Fscripts%2Fmaster%2Fexample-script%2Finfo.json) to help you with the json encoding
- **commit and push** your changes to your repository
- create a **[pull request](https://help.github.com/articles/creating-a-pull-request/)** to get your script merged into the QOwnNotes script repository