Skip to content

Commit

Permalink
README, CONTRIBUTING, .gitignore
Browse files Browse the repository at this point in the history
  • Loading branch information
microbit-sam committed Mar 3, 2021
1 parent 4df7811 commit 9947ae2
Show file tree
Hide file tree
Showing 3 changed files with 107 additions and 1 deletion.
89 changes: 89 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -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

8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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).

0 comments on commit 9947ae2

Please sign in to comment.