Skip to content

Add license info to README, add CONTRIBUTING and CONTRIBUTORS files. #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 5, 2019
Merged

Add license info to README, add CONTRIBUTING and CONTRIBUTORS files. #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Thanks for looking here! We'd love your help. The micro:bit project is only
possible through contributions of companies and individuals around the world.

This project is managed on GitHub, and the best way to contribute is to jump in
and fix/file issues.

https://github.com/microbit-foundation/microbit-fs

If you're interested in working on any of these items, please file an issue
and mention @microbit-carlos.
5 changes: 5 additions & 0 deletions CONTRIBUTORS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Thank you to everybody that has contributed to the microbit-fs project:

Carlos Pereira Atencio (carlos@microbit.org)
Ross Lowe (ross@microbit.org)
Matt Hillsdon (matt.hillsdon@microbit.org)
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
# micro:bit MicroPython Filesystem

A TypeScript library to manipulate the micro:bit filesystem.
A TypeScript library to manipulate the micro:bit MicroPython filesystem.

<img width="50%" alt="microbit-fs logo" src="https://user-images.githubusercontent.com/29712657/53014294-fb95e700-343f-11e9-856e-d70af8870c0c.png">

This library is a Work In Progress. At the moment only the MicroPython filesystem within a hex file is supported.
This library is a Work In Progress. At the moment only the MicroPython
filesystem within a hex file is supported.

Raw draft of the docs can be found in
[https://microbit-foundation.github.io/microbit-fs/](https://microbit-foundation.github.io/microbit-fs/).


## License

This software is under the MIT open source license.

SPDX-License-Identifier: MIT