TiLDA MK4/Badge Store Submissions - Revision history

Davea: /* Headers */

2018-09-09T16:24:50Z

Headers

← Older revision		Revision as of 16:24, 9 September 2018
Line 20:		Line 20:

	<pre>		<pre>
	~~___name___~~ = "<your_app_name>"		___title___ = "<your_app_name>"
	___license___ = "MIT"		___license___ = "MIT"
	___dependencies___ = ["wifi", "http", "ugfx_helper", "sleep"]		___dependencies___ = ["wifi", "http", "ugfx_helper", "sleep"]

Hans: Fix type

2018-08-29T19:54:51Z

Fix type

← Older revision		Revision as of 19:54, 29 August 2018
Line 50:		Line 50:
	* Create a Pull Request [https://github.com/emfcamp/Mk4-Apps/blob/master/CONTRIBUTING.md#using-git-and-github-to-submit-your-badge-app]		* 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 [https://github.com/emfcamp/Mk4-Apps/blob/master/CONTRIBUTING.md#updating-your-github-and-local-git-repo]		* 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]

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

Steve Amor at 18:16, 29 August 2018

2018-08-29T18:16:19Z

← Older revision		Revision as of 18:16, 29 August 2018
Line 1:		Line 1:
	~~Todo: Please elaborate on these steps~~

	== Rules for apps in the official badge store ==		== Rules for apps in the official badge store ==

Steve Amor: /* Submitting your badge app to the official badge store */

2018-08-29T18:16:01Z

Submitting your badge app to the official badge store

← Older revision		Revision as of 18:16, 29 August 2018
Line 48:		Line 48:
	* 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]		* 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 [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 [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 [https://github.com/emfcamp/Mk4-Apps/blob/master/CONTRIBUTING.md#using-git-and-github-to-submit-your-badge-app] ~~(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 [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 [https://github.com/emfcamp/Mk4-Apps/blob/master/CONTRIBUTING.md#using-git-and-github-to-submit-your-badge-app]
	* Create a Pull Request [https://github.com/emfcamp/Mk4-Apps/blob/master/CONTRIBUTING.md#using-git-and-github-to-submit-your-badge-app]		* 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 [https://github.com/emfcamp/Mk4-Apps/blob/master/CONTRIBUTING.md#updating-your-github-and-local-git-repo]		* 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 [https://github.com/emfcamp/Mk4-Apps/blob/master/CONTRIBUTING.md#updating-your-github-and-local-git-repo]

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

Steve Amor at 18:13, 29 August 2018

2018-08-29T18:13:58Z

← Older revision		Revision as of 18:13, 29 August 2018
Line 46:		Line 46:
	* 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] (maybe mention https://desktop.github.com/ ?)
	* 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 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 [https://github.com/emfcamp/Mk4-Apps/blob/master/CONTRIBUTING.md#updating-your-github-and-local-git-repo]

Marekventur: /* Packaging up your badge app for submission to the store */

2018-08-29T17:48:53Z

Packaging up your badge app for submission to the store

← Older revision		Revision as of 17:48, 29 August 2018
Line 21:		Line 21:
	main.py headers:		main.py headers:

	___name___ = "<your_app_name>"~~<br />~~		<pre>
	___license___ = "MIT"~~<br />~~		___name___ = "<your_app_name>"
	___dependencies___ = ["wifi", "http", "ugfx_helper", "sleep"]~~<br />~~		___license___ = "MIT"
	___categories___ = ["<see below>"]~~<br />~~		___dependencies___ = ["wifi", "http", "ugfx_helper", "sleep"]
	___bootstrapped___ = True<br />		___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:		Please use one of these categories:

Steve Amor: /* Packaging up your badge app for submission to the store */

2018-08-29T17:33:53Z

Packaging up your badge app for submission to the store

@@ Line 11: / Line 11: @@
 == 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.
+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.
 == Submitting your badge app to the official badge store ==

Steve Amor: /* Packaging up your badge app for submission to the store */

2018-08-29T17:19:03Z

Packaging up your badge app for submission to the store

← Older revision		Revision as of 17:19, 29 August 2018
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.		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.		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.

Steve Amor: /* Packaging up your badge app for submission to the store */

2018-08-29T17:18:33Z

Packaging up your badge app for submission to the store

← Older revision		Revision as of 17:18, 29 August 2018
Line 11:		Line 11:
	== Packaging up your badge app for submission to the store ==		== Packaging up your badge app for submission to the store ==

	~~Todo: How~~ to ~~package 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 ==

Steve Amor at 15:36, 29 August 2018

2018-08-29T15:36:32Z

@@ Line 1: / Line 1: @@
 Todo: Please elaborate on these steps
 == Packaging up your badge app for submission to the store ==
@@ Line 16: / Line 24: @@
 * 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)