Documentation - Githubissues

emfcamp / Mk4-Apps

Apps to download and run on the Mk4 badge

54 stars 122 forks source link

Documentation #11

Open marekventur opened 6 years ago

marekventur commented 6 years ago

https://badge.emfcamp.org/wiki/TiLDA_MK4

[ ] Copy relevant sections from last time
[ ] Update UGFX section
[ ] Update libs section
[ ] Update badge store section
[ ] Update reset / dfu section (what to do if badge doesn't work anymore)
[ ] Explain how to clone a github repo
[ ] Explain how to open a PR
[ ] "My first app"

SteveAmor commented 6 years ago

@marekventur I'm happy to do:

Explain how to clone a github repo
Explain how to open a PR

How do you want people to submit this info?

marekventur commented 6 years ago

Thanks @SteveAmor!

I think the best place to start is the mk4 wiki: https://badge.emfcamp.org/wiki/TiLDA_MK4

just create a github page (or something similar) and add a link to it to the (so far empty) main page. We can sort the proper landing page out later - it will probably looks similar to https://badge.emfcamp.org/wiki/TiLDA_MK3

marekventur commented 6 years ago

I've created the base page: https://badge.emfcamp.org/wiki/TiLDA_MK4

marekventur commented 6 years ago

probably here: https://badge.emfcamp.org/wiki/TiLDA_MK4/Badge_Store_Submissions

SteveAmor commented 6 years ago

@marekventur can you check the flow I've put in https://badge.emfcamp.org/wiki/TiLDA_MK4/Badge_Store_Submissions I'm creating a PR to update contributing.md with most of the instructions in. Where will the contributors apps end up? emfcamp/Mk4-apps/apps ?? And how do you want the apps packaged up, just in a directory with a unique app name?

marekventur commented 6 years ago

Where will the contributors apps end up? And how do you want the apps packaged up, just in a directory with a unique app name?

Every app becomes a new folder in the root of the repo. So if someone creates a "snake" app, there will be another 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.

You can verify that the folder structure is correct by running "./tilda_tools validate" (works without a badge), which is also run by travis to check PRs.