TiLDA MK4/Badge Store Submissions: Difference between revisions
Jump to navigation
Jump to search
Steve Amor (talk | contribs) No edit summary |
Steve Amor (talk | contribs) |
||
Line 11: | Line 11: | ||
== Packaging up your badge app for submission to the store == | == Packaging up your badge app for submission to the store == | ||
Every app becomes a new folder in the root of the Mk4-App repo. So if you create a "snake" app, you need to put your program files in a folder called "snake" with at least a "main.py" in it. | |||
App names need to be unique (the folder structure enforces that). App folders can contain multiple files (python and non python), but at a minimum "main.py" with the correct headers is required. | |||
Plesae verify that your apps folder structure is correct by running "./tilda_tools validate" (this works without a badge) before submitting it to the badge app store as the validations is also run by Travis to check pull requests. | |||
== Submitting your badge app to the official badge store == | == Submitting your badge app to the official badge store == |
Revision as of 17:18, 29 August 2018
Todo: Please elaborate on these steps
Rules for apps in the official badge store
- App has to be "Rated G: General Audiences – all ages admitted"
- App should not be of malicious nature
- App complies with EMF's Code of Conduct
- No code/image hot-loading without good reasons (since it might be change after the review process)
- It's fine for people to improve on Apps other have written. Likewise, if you submit an App, be aware that others can and will make changes to it.
Packaging up your badge app for submission to the store
Every app becomes a new folder in the root of the Mk4-App repo. So if you create a "snake" app, you need to put your program files in a folder called "snake" with at least a "main.py" in it.
App names need to be unique (the folder structure enforces that). App folders can contain multiple files (python and non python), but at a minimum "main.py" with the correct headers is required.
Plesae verify that your apps folder structure is correct by running "./tilda_tools validate" (this works without a badge) before submitting it to the badge app store as the validations is also run by Travis to check pull requests.
Submitting your badge app to the official badge store
- Create a GitHub account [1]
- Download and install git on your local computer [2]
- Set up git on your local computer with your username and email address (link to set up user and email)
- Fork the emfcamp/Mk4-Apps repo (link)
- Clone your GitHub repo to your computer (link) (maybe mention https://desktop.github.com/ ?)
- Add your app to your local repo (link)
- Create a Pull Request (link)
- Over time, your GitHub report will get out of sync with the changes that have been made to the emfcamp/Mk4-Apps repo so you will need to update your GitHub repo (link)