Skip to content

Commit 0b66fd3

Browse files
committed
add license, readme and changelog
1 parent 6fb4ace commit 0b66fd3

6 files changed

Lines changed: 39 additions & 2 deletions

File tree

LICENSE.txt

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Oliver Fabel
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

docs/CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## 1.0
2+
3+
* Initial stable release for the [flipper lab](https://lab.flipper.net/apps)
4+
5+
https://github.com/ofabel/mp-flipper/releases/tag/v1.0.0

docs/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# MicroPython
2+
3+
[MicroPython](https://micropython.org/) is a version of the popular [Python](https://www.python.org/) programming language, especially tailored for the hardware requirements of small microcontrollers, like the Flipper Zero.
4+
Instead of supporting the full standard library, only a subset is implemented, carefully selected with the requirements of a microcontroller environment in mind.
5+
But this should not limit your creativity and ability to create great applications at all.
6+
7+
## Disclaimer
8+
9+
Running MicroPython is a heavy task for the Flipper.
10+
This does sometimes lead to an _Out of Memory_ error.
11+
**This doesn't harm your Flipper.**

docs/file-browser.png

2.22 KB
Loading

docs/tic-tac-toe.png

1.22 KB
Loading

publish.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ git clone --branch ${BRANCH} --single-branch ${REMOTE} ${TARGET} || (git init -b
1212

1313
rm -rf ${TARGET}/*
1414

15-
cp upython.c application.fam icon.png *.md ${TARGET}
16-
cp -r ./assets ./examples ./lib ${TARGET}
15+
cp upython.c application.fam icon.png LICENSE.txt ${TARGET}
16+
cp -r ./docs ./examples ./lib ${TARGET}
1717

1818
cd ${TARGET}
1919

0 commit comments

Comments
 (0)