Просмотр исходного кода

add license, readme and changelog

Oliver Fabel 1 год назад
Родитель
Сommit
0b66fd3ae0
6 измененных файлов с 39 добавлено и 2 удалено
  1. 21 0
      LICENSE.txt
  2. 5 0
      docs/CHANGELOG.md
  3. 11 0
      docs/README.md
  4. BIN
      docs/file-browser.png
  5. BIN
      docs/tic-tac-toe.png
  6. 2 2
      publish.sh

+ 21 - 0
LICENSE.txt

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

+ 5 - 0
docs/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 1.0
+
+* Initial stable release for the [flipper lab](https://lab.flipper.net/apps)
+
+https://github.com/ofabel/mp-flipper/releases/tag/v1.0.0

+ 11 - 0
docs/README.md

@@ -0,0 +1,11 @@
+# MicroPython
+
+[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.
+Instead of supporting the full standard library, only a subset is implemented, carefully selected with the requirements of a microcontroller environment in mind.
+But this should not limit your creativity and ability to create great applications at all.
+
+## Disclaimer
+
+Running MicroPython is a heavy task for the Flipper.
+This does sometimes lead to an _Out of Memory_ error.
+**This doesn't harm your Flipper.**

BIN
docs/file-browser.png


BIN
docs/tic-tac-toe.png


+ 2 - 2
publish.sh

@@ -12,8 +12,8 @@ git clone --branch ${BRANCH} --single-branch ${REMOTE} ${TARGET} || (git init -b
 
 rm -rf ${TARGET}/*
 
-cp upython.c application.fam icon.png *.md ${TARGET}
-cp -r ./assets ./examples ./lib ${TARGET}
+cp upython.c application.fam icon.png LICENSE.txt ${TARGET}
+cp -r ./docs ./examples ./lib ${TARGET}
 
 cd ${TARGET}