Skip to content

Commit e7af418

Browse files
Add README
1 parent 6d0b8ec commit e7af418

File tree

5 files changed

+69
-1
lines changed

5 files changed

+69
-1
lines changed

.editorconfig

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 2
6+
end_of_line = lf
7+
charset = utf-8
8+
trim_trailing_whitespace = true
9+
insert_final_newline = true
10+
11+
[*.md]
12+
trim_trailing_whitespace = false

.gitignore

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# ignore files generated by https://github.com/CodeClub/slash-learning-content-preview
2+
*/preview-*.html
3+
4+
### Python ###
5+
env/
6+
7+
### Emacs ###
8+
\#*\#
9+
10+
### MacOS ###
11+
.DS_STORE

CONTRIBUTING.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contributing
2+
3+
All contributions are assumed to be licensed under the same licence as the source, i.e. [CC BY-SA](http://creativecommons.org/licenses/by-sa/4.0/). This licence must remain in all derivatives of this work.
4+
5+
## Issues
6+
7+
If you find a mistake, bug, or other problem, please [open an issue](https://github.com/raspberrypilearning/repo-name/issues) in this repository.
8+
9+
## Pull requests
10+
11+
All edits to a resource should be made to the draft branch or to a fork of the repo. These patches can then be submitted as a pull request.
12+
13+
If you fix a mistake, bug, or problem or have something to contribute, please create a pull request for each modification. Please consider grouping modifications sensibly, e.g. don't bundle typo fixes in the same pull request as code changes, file them separately instead.
14+
15+
Please note that sometimes things are done for pedagogical reasons so changes which make sense from a software engineering perspective (reducing duplication or making use of more advanced programming language features) may not be suitable to maintain the intended educational value.
16+
17+
## Derivatives
18+
19+
See [LICENCE.md](LICENCE.md) for content licence. The licence must remain in all derivatives of this work.
20+
21+
## Translation
22+
23+
You can help us make this project available to more people around the world by translating it. For more information, please go to [rpf.io/translate](http://rpf.io/translate).

LICENCE.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Licence
2+
3+
Unless otherwise specified, everything in this repository is covered by the following licence:
4+
5+
[![Creative Commons licence](http://i.creativecommons.org/l/by-sa/4.0/88x31.png)](http://creativecommons.org/licenses/by-sa/4.0/)
6+
7+
***PROJECT NAME*** by the [Raspberry Pi Foundation](http://www.raspberrypi.org) is licensed under a [Creative Commons Attribution 4.0 International licence](http://creativecommons.org/licenses/by-sa/4.0/).
8+
9+
Based on a work at https://github.com/raspberrypilearning/project-name.

README.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,14 @@
1-
# teach-a-computer-to-read
1+
# teach-a-computer-to-read
2+
3+
![teach-a-computer-to-read](banner.png)
4+
5+
Find the project online at [projects.raspberrypi.org/en/projects/teach-a-computer-to-read](https://projects.raspberrypi.org/en/projects/teach-a-computer-to-read)
6+
7+
## Resources
8+
For project materials and solutions, see [en/resources](https://github.com/raspberrypilearning/teach-a-computer-to-read/tree/master/en/resources) and [en/solutions](https://github.com/raspberrypilearning/teach-a-computer-to-read/tree/master/en/solutions).
9+
10+
## Contributing
11+
See [CONTRIBUTING.md](CONTRIBUTING.md)
12+
13+
## Licence
14+
See [LICENCE.md](LICENCE.md)

0 commit comments

Comments
 (0)