Merge pull request #2 from microbit-foundation/open-source

Open source repo

.gitignore

@@ -0,0 +1,89 @@
+# Built application files
+*.apk
+*.aar
+*.ap_
+*.aab
+
+# Files for the ART/Dalvik VM
+*.dex
+
+# Java class files
+*.class
+
+# Generated files
+bin/
+gen/
+out/
+#  Uncomment the following line in case you need and you don't have the release build type files in your app
+# release/
+
+# Gradle files
+.gradle/
+build/
+
+# Local configuration file (sdk path, etc)
+local.properties
+
+# Proguard folder generated by Eclipse
+proguard/
+
+# Log Files
+*.log
+
+# Android Studio Navigation editor temp files
+.navigation/
+
+# Android Studio captures folder
+captures/
+
+# IntelliJ
+*.iml
+.idea/workspace.xml
+.idea/tasks.xml
+.idea/gradle.xml
+.idea/assetWizardSettings.xml
+.idea/dictionaries
+.idea/libraries
+# Android Studio 3 in .gitignore file.
+.idea/caches
+.idea/modules.xml
+# Comment next line if keeping position of elements in Navigation Editor is relevant for you
+.idea/navEditor.xml
+
+# Keystore files
+# Uncomment the following lines if you do not want to check your keystore files in.
+#*.jks
+#*.keystore
+
+# External native build folder generated in Android Studio 2.2 and later
+.externalNativeBuild
+.cxx/
+
+# Google Services (e.g. APIs or Firebase)
+# google-services.json
+
+# Freeline
+freeline.py
+freeline/
+freeline_project_description.json
+
+# fastlane
+fastlane/report.xml
+fastlane/Preview.html
+fastlane/screenshots
+fastlane/test_output
+fastlane/readme.md
+
+# Version control
+vcs.xml
+
+# lint
+lint/intermediates/
+lint/generated/
+lint/outputs/
+lint/tmp/
+# lint/reports/
+
+# Android Profiling
+*.hprof
+

CONTRIBUTING.md

@@ -0,0 +1,8 @@
+
+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/android-partial-flashing-lib
+
+If you're interested in working on any of these items, please file an issue and tag @microbit-sam.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Micro:bit Educational Foundation
+
+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.

README.md

@@ -1,7 +1,8 @@
 # micro:bit Partial Flashing Library for Android
 
-This library provides partial flashing capabilities to an Android application. It will process a hex file created in MakeCode and flash only the MakeCode script.
+This library provides partial flashing capabilities to an Android application.
 
+It will process a hex file created in MakeCode or the Python Editor and flash only the user script.
 To modularize the code, information is passed to and from the library using Intents.
 
 ## Including the lib in an application
@@ -81,3 +82,11 @@ An example that forwards the information to a React Native app:
 
 ...
 ```
+
+## Partial Flashing Algorithm
+
+More information on the partial flashing algorithm can be found [here](https://github.com/lancaster-university/codal-microbit-v2/blob/master/docs/MemoryMap.md).
+
+## Code of Conduct
+
+When interacting with this repository please follow the Micro:bit Foundation's [Code of Conduct](https://microbit.org/terms-of-use/#the-micro:bit-educational-foundation-code-of-conduct).

src/main/java/org/microbit/android/partialflashing/HexUtils.java

@@ -18,6 +18,10 @@
  * A Class to manipulate micro:bit hex files
  * Focused towards stripping a file down to it's PXT section for use in Partial Flashing
  *
+ *   (c) 2017 - 2021, Micro:bit Educational Foundation and contributors
+ *
+ *  SPDX-License-Identifier: MIT
+ *
  */
 
 public class HexUtils {

src/main/java/org/microbit/android/partialflashing/PartialFlashingBaseService.java

@@ -30,6 +30,10 @@
 /**
  * A class to communicate with and flash the micro:bit without having to transfer the entire HEX file
  * Created by samkent on 07/11/2017.
+ *
+ * (c) 2017 - 2021, Micro:bit Educational Foundation and contributors
+ *
+ * SPDX-License-Identifier: MIT
  */
 
 // A service that interacts with the BLE device via the Android BLE API.