Difference between revisions of "TiLDA MK4/Badge Store Submissions"

From EMF Badge
Jump to navigation Jump to search
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
Todo: Please elaborate on these steps
+
== Rules for apps in the official badge store ==
  
−
Todo: How to package up your badge app for submission to the store
+
* App has to be "Rated G: General Audiences – all ages admitted"
 +
* App should not be of malicious nature
 +
* App complies with EMF's [https://www.emfcamp.org/code-of-conduct 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 ==
 
== Packaging up your badge app for submission to the store ==
 +
 +
Every app becomes a new folder in the root of the Mk4-App GitHub repository. 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.
 +
 +
=== Headers ===
 +
 +
main.py headers:
 +
 +
<pre>
 +
___title___        = "<your_app_name>"
 +
___license___      = "MIT"
 +
___dependencies___ = ["wifi", "http", "ugfx_helper", "sleep"]
 +
___categories___  = ["<see below>"]
 +
___bootstrapped___ = True # Whether or not apps get downloaded on first install. Defaults to "False", mostly likely you won't have to use this at all.
 +
</pre>
 +
 +
Please use one of these categories:
 +
* System
 +
* Homescreens
 +
* Games
 +
* Sound
 +
* EMF
 +
* Villages
 +
* Phone
 +
* LEDs
 +
* Sensors
 +
* Demo
 +
* Other
  
 
== Submitting your badge app to the official badge store ==
 
== Submitting your badge app to the official badge store ==
Line 9: Line 44:
 
* Create a GitHub account [https://github.com/join]
 
* Create a GitHub account [https://github.com/join]
 
* Download and install git on your local computer [https://git-scm.com/downloads]
 
* Download and install git on your local computer [https://git-scm.com/downloads]
−
* Set up git on your local computer with your username and email address (link to set up user and email)
+
* Set up git on your local computer with your username and email address [https://github.com/emfcamp/Mk4-Apps/blob/master/CONTRIBUTING.md#using-git-and-github-to-submit-your-badge-app]
−
* Fork the emfcamp/Mk4-Apps repo (link)
+
* Fork the emfcamp/Mk4-Apps repo [https://github.com/emfcamp/Mk4-Apps/blob/master/CONTRIBUTING.md#using-git-and-github-to-submit-your-badge-app]
−
* Clone '''your''' GitHub repo to your computer (link) (maybe mention https://desktop.github.com/ ?)
+
* Clone '''your''' GitHub repo to your computer [https://github.com/emfcamp/Mk4-Apps/blob/master/CONTRIBUTING.md#using-git-and-github-to-submit-your-badge-app]
−
* Add your app to your local repo (link)
+
* Add your app to your local repo [https://github.com/emfcamp/Mk4-Apps/blob/master/CONTRIBUTING.md#using-git-and-github-to-submit-your-badge-app]
−
* Create a Pull Request (link)
+
* Create a Pull Request [https://github.com/emfcamp/Mk4-Apps/blob/master/CONTRIBUTING.md#using-git-and-github-to-submit-your-badge-app]
  
−
* 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)
+
* Over time, your GitHub repo 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 [https://github.com/emfcamp/Mk4-Apps/blob/master/CONTRIBUTING.md#updating-your-github-and-local-git-repo]
−
 
 
−
== Rules for apps in the official badge store ==
 
  
−
* App has to be "Rated G: General Audiences – all ages admitted"
+
If you prefer a GUI interface, you could consider https://desktop.github.com/
−
* App should not be of malicious nature
 
−
* App complies with EMF's [https://www.emfcamp.org/code-of-conduct 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.
 

Latest revision as of 16:24, 9 September 2018

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 GitHub repository. 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.

Headers

main.py headers: 

___title___         = "<your_app_name>"
___license___      = "MIT"
___dependencies___ = ["wifi", "http", "ugfx_helper", "sleep"]
___categories___   = ["<see below>"]
___bootstrapped___ = True # Whether or not apps get downloaded on first install. Defaults to "False", mostly likely you won't have to use this at all.

Please use one of these categories:

  • System
  • Homescreens
  • Games
  • Sound
  • EMF
  • Villages
  • Phone
  • LEDs
  • Sensors
  • Demo
  • Other

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 [3]
  • Fork the emfcamp/Mk4-Apps repo [4]
  • Clone your GitHub repo to your computer [5]
  • Add your app to your local repo [6]
  • Create a Pull Request [7]
  • Over time, your GitHub repo 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 [8]

If you prefer a GUI interface, you could consider https://desktop.github.com/

Retrieved from "https://badge.emfcamp.org/w/index.php?title=TiLDA_MK4/Badge_Store_Submissions&oldid=435"