Skip to content

Commit

Permalink
clarification that SDK only works with move2
Browse files Browse the repository at this point in the history
  • Loading branch information
annescharf committed Oct 18, 2023
1 parent 2f3fb98 commit 8d3c2df
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG_SDK.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@
- introduces template versioning (starting w/ `v3.0.0` as this is the third major iteraction)
- introduces `dotenv` to control/adjust local app-development
- updates developer readme
- introduces a _Template Syncronisation_ GH action. Use it to synchronize your forked app with template updates. If you already forked from the template _before_ SDK `v3.0.0` you can manually add the files `.github/workflows/template-sync.yml` and `.github/.templatesyncignore` to your fork. With these files you can manually execute the GH action named _.github/workflows/template-sync.yml_.
- introduces a _Template Syncronisation_ GH action. Use it to synchronize your forked app with template updates. If you already forked from the template _before_ SDK `v3.0.0` you can manually add the files `.github/workflows/template-sync.yml` and `.github/.templatesyncignore` to your fork. With these files you can manually execute the GH action named _.github/workflows/template-sync.yml_. *Only use this option if your app is written for input data of class `move2`*

- fix app-configuration for execution on moveapps.org
- clear app output of previously app run at each start of the SDK

- SDK supports [`move2`](https://gitlab.com/bartk/move2/) and prefers it over [`move`](https://gitlab.com/bartk/move/).
- SDK supports [`move2`](https://gitlab.com/bartk/move2/), if input is of class [`move`](https://gitlab.com/bartk/move/) it will be converted into class `move2`.
- output is always move2
- Upgrade `R` framework to `4.3.1`
2 changes: 2 additions & 0 deletions developer_README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# MoveApps R Software Development Kit (SDK)

##### ***NOTE*: this SDK only supports code written for input data of class `move2`. Please contact us under [email protected] if you have any questions.**

This documentation provides a short introduction to the [MoveApps](https://www.moveapps.org) **R SDK**.

As a first step, and before your read this, you should have used this GitHub template to create a copy of it in your personal space and named the repository as your App will be named in MoveApps.
Expand Down

0 comments on commit 8d3c2df

Please sign in to comment.