Skip to content

Commit 43179f8

Browse files
committed
update
1 parent e33ac39 commit 43179f8

File tree

1 file changed

+20
-12
lines changed

1 file changed

+20
-12
lines changed

README.md

+20-12
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,22 @@
11
# Components Section
22

3-
Repository for the microbit playground [components section](https://microbit-playground.co.uk/components/).
3+
The microbit playground website is built from these repositories on github:
44

5-
This repository is checked out at build time. There is a `draft` branch and a `publish` branch. All changes should be made to the `draft` branch and merged into publish with a squash.
5+
* [**Program** section](https://microbit-playground.co.uk/programs/) [[repository](https://github.com/microbit-playground/programs)]
6+
* [**Components** section](https://microbit-playground.co.uk/components/) [[repository](https://github.com/microbit-playground/components)]
7+
* [**Blog posts** section](https://microbit-playground.co.uk/blog/) [[repository](https://github.com/microbit-playground/blog-posts)]
8+
* [**How to** section](https://microbit-playground.co.uk/howto/) [[repository](https://github.com/microbit-playground/programs)]
69

7-
### Contributing
10+
You can add a page to the website by adding to the repository.
11+
12+
This repository is checked out at build time. There is a `draft` branch and a `publish` branch. All changes should be made to the `draft` branch.
13+
14+
## Contributing
815
See [the page on the website](https://microbit-playground.co.uk/about/how-to-contribute). Submissions are welcome.
916

1017
Submit an issue if you have an idea for an article.
1118

12-
##### A Contribution Should...
19+
### A Contribution Should...
1320
* Not contain fixes or additions to existing articles; please use 'Issues'.
1421
* Be a pull request to the `draft` branch.
1522
* Have a `720x420px` `.png` teaser image in `/teaser/`.
@@ -18,29 +25,30 @@ Submit an issue if you have an idea for an article.
1825
* Licensed images used are mentioned in the `YAML` frontmatter of the `.md` file in the `acknowledgements` field if required.
1926
* Nothing too spammy or marketty or Google juicy.
2027

21-
###### Optional
22-
* For public attribution on the website, add your name and details to the author repository.
28+
### Optional
29+
* For public attribution on the website, add your name and details to the [author repository](https://github.com/microbit-playground/author-database).
2330

24-
###### A Brief Note
31+
## A Brief Note
2532
Github is very rude! I do not mean the people but github.com. Picture the scene: you spend an age writing an article and are filled with pride and goodness about helping kids & adults learn. When I review and start to edit it, __rejected__ or __changes requested__ appears!
2633

2734
Perhaps this works fine in some areas but I know there is an emotional attachment when writing learning resources.
2835

29-
So please, do please translate these messages from robot into Human.
36+
So please, do please translate these message from robot into Human.
37+
3038

31-
### Files in Repository
39+
## Files in Repository
3240
The website's pages are generated from `.md` files in the main directory. The name of each `.md` file has a corresponding image in `/teaser/` of the same name.
3341

3442
* `/images/` -- Images used in the article.
3543
* `/teaser/` -- Directory for teaser images & video.
3644
* `/teaser/tiny` & `/teaser/card` -- Generated images sizes.
3745
* `/KITCHENSINK.md` -- Examples for fomatting.
3846

39-
### Licensing
40-
#### Contributions
47+
## Licensing
48+
### Contributions
4149
Each submission is covered by the CC-BY-NC 3.0 licence. You retain copyright but allows the website to use it (but not make money).
4250

43-
#### Images
51+
### Images
4452

4553

4654
| Image Name | Author | Licence |

0 commit comments

Comments
 (0)