Merge branch 'readme' into develop

# Conflicts:
#	CHANGELOG.md
#	app/src/main/java/com/mapcode/map/AddressUi.kt
#	app/src/main/java/com/mapcode/map/ClearableTextField.kt
#	app/src/main/java/com/mapcode/map/ShowMapcodeUseCase.kt

Author: sds100

.gitignore

@@ -1,89 +1,156 @@
+# Created by https://www.toptal.com/developers/gitignore/api/androidstudio,java
+# Edit at https://www.toptal.com/developers/gitignore?templates=androidstudio,java
+
+### Java ###
+# Compiled class file
+*.class
+
+# Log file
+*.log
+
+# BlueJ files
+*.ctxt
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.jar
+*.war
+*.nar
+*.ear
+*.zip
+*.tar.gz
+*.rar
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+replay_pid*
+
+### AndroidStudio ###
+# Covers files to be ignored for android development using Android Studio.
+
 # 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
 .gradle/
 build/
 
+# Signing files
+.signing/
+
 # Local configuration file (sdk path, etc)
 local.properties
 
 # Proguard folder generated by Eclipse
 proguard/
 
 # Log Files
-*.log
 
-# Android Studio Navigation editor temp files
+# Android Studio
+/*/build/
+/*/local.properties
+/*/out
+/*/*/build
+/*/*/production
+captures/
 .navigation/
+*.ipr
+*~
+*.swp
 
-# Android Studio captures folder
-captures/
+# Keystore files
+*.jks
+*.keystore
+
+# Google Services (e.g. APIs or Firebase)
+# google-services.json
+
+# Android Patch
+gen-external-apklibs
+
+# External native build folder generated in Android Studio 2.2 and later
+.externalNativeBuild
 
-# IntelliJ
+# NDK
+obj/
+
+# IntelliJ IDEA
 *.iml
+*.iws
+/out/
+
+# User-specific configurations
+.idea/caches/
+.idea/libraries/
+.idea/shelf/
 .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/.name
+.idea/compiler.xml
+.idea/copyright/profiles_settings.xml
+.idea/encodings.xml
+.idea/misc.xml
 .idea/modules.xml
-# Comment next line if keeping position of elements in Navigation Editor is relevant for you
+.idea/scopes/scope_settings.xml
+.idea/dictionaries
+.idea/vcs.xml
+.idea/jsLibraryMappings.xml
+.idea/datasources.xml
+.idea/dataSources.ids
+.idea/sqlDataSources.xml
+.idea/dynamic.xml
+.idea/uiDesigner.xml
+.idea/assetWizardSettings.xml
+.idea/gradle.xml
+.idea/jarRepositories.xml
 .idea/navEditor.xml
-.idea/androidTestResultsUserPreferences.xml
-.idea/misc.xml
-.idea/inspectionProfiles
-.idea/deploymentTargetDropDown.xml
 
-# Keystore files
-# Uncomment the following lines if you do not want to check your keystore files in.
-#*.jks
-#*.keystore
+# Legacy Eclipse project files
+.classpath
+.project
+.cproject
+.settings/
 
-# External native build folder generated in Android Studio 2.2 and later
-.externalNativeBuild
-.cxx/
+# Mobile Tools for Java (J2ME)
 
-# Google Services (e.g. APIs or Firebase)
-# google-services.json
+# Package Files #
+
+# virtual machine crash logs (Reference: http://www.java.com/en/download/help/error_hotspot.xml)
+
+## Plugin-specific files:
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Mongo Explorer plugin
+.idea/mongoSettings.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+### AndroidStudio Patch ###
+
+!/gradle/wrapper/gradle-wrapper.jar
 
-# 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/
+# End of https://www.toptal.com/developers/gitignore/api/androidstudio,java

.idea/misc.xml

@@ -1,6 +1,6 @@
 ## [1.1.0](https://github.com/mapcode-foundation/mapcode-android-app/releases/tag/v1.1.0)
 
-#### 9 August 2022
+#### 2022-08-09
 
 - [#39](https://github.com/mapcode-foundation/mapcode-android-app/issues/39) Call REST API when querying mapcodes.
 - [#20](https://github.com/mapcode-foundation/mapcode-android-app/issues/20) Show a dropdown that suggests addresses
@@ -17,14 +17,14 @@
 
 ## [1.0.1](https://github.com/mapcode-foundation/mapcode-android-app/releases/tag/v1.0.1)
 
-#### 5 August 2022
+#### 2022-08-05
 
 - [#38](https://github.com/mapcode-foundation/mapcode-android-app/issues/38) Show error when inputting invalid latitude
   and longitude to fix the crash.
 - Hide buttons that link to the GitHub repo and changelog until the repo is made public.
 
 ## [1.0.0](https://github.com/mapcode-foundation/mapcode-android-app/releases/tag/v1.0.0)
 
-#### 21 July 2022
+#### 2022-07-21
 
 Initial release! 🎉

CHANGELOG.md

@@ -1,2 +1,50 @@
-# mapcode-android-app
-Mapcode Android app
+# Mapcode Android Application
+
+[![License](http://img.shields.io/badge/license-APACHE2-blue.svg)]()
+
+**Copyright (C) 2014-2022 Stichting Mapcode Foundation (http://www.mapcode.com)**
+
+This is Mapcode Finder, the official Android application for mapcodes. Have fun using it!
+
+Rijn Buve
+
+# License
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+# Using Git and `.gitignore`
+
+It's good practice to set up a personal global `.gitignore` file on your machine which filters a number of files
+on your file systems that you do not wish to submit to the Git repository. You can set up your own global
+`~/.gitignore` file by executing:
+`git config --global core.excludesfile ~/.gitignore`
+
+The local `.gitignore` file in the Git repository itself to reflect those file only that are produced by executing
+regular compile, build or release commands, such as:
+`target/ out/`
+
+Tip: Use [gitignore.io](http://gitignore.io) to generate or update the `.gitignore` file.
+
+# Bug Reports and New Feature Requests
+
+If you encounter any problems with this library, don't hesitate to use the `Issues` session to file your issues.
+Normally, one of our developers should be able to comment on them and fix.
+
+# Release Notes
+
+See [CHANGELOG.md](./CHANGELOG.md) for release notes.xz
+
+# Credits
+
+Special thanks to Seth Schroeder for developing Android version of this app.
+

README.md

@@ -1,3 +1,19 @@
+/*
+ * Copyright (C) 2022, Stichting Mapcode Foundation (http://www.mapcode.com)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package com.mapcode
 
 import androidx.datastore.preferences.core.Preferences
@@ -6,9 +22,6 @@ import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.map
 
-/**
- * Created by sds100 on 26/04/2021.
- */
 class FakePreferenceRepository : PreferenceRepository {
     private val preferences: MutableStateFlow<Map<Preferences.Key<*>, Any?>> = MutableStateFlow(emptyMap())
 

app/src/androidTest/java/com/mapcode/FakePreferenceRepository.kt

@@ -1,10 +1,23 @@
+/*
+ * Copyright (C) 2022, Stichting Mapcode Foundation (http://www.mapcode.com)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package com.mapcode.map
 
 import com.mapcode.Mapcode
 
-/**
- * Created by sds100 on 02/06/2022.
- */
 data class FakeLocation(
     val latitude: Double,
     val longitude: Double,

app/src/androidTest/java/com/mapcode/map/FakeLocation.kt

@@ -1,3 +1,19 @@
+/*
+ * Copyright (C) 2022, Stichting Mapcode Foundation (http://www.mapcode.com)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package com.mapcode.map
 
 import com.mapcode.Mapcode
@@ -9,9 +25,6 @@ import java.io.IOException
 import kotlin.Result.Companion.failure
 import kotlin.Result.Companion.success
 
-/**
- * Created by sds100 on 02/06/2022.
- */
 class FakeShowMapcodeUseCase : ShowMapcodeUseCase {
     var clipboard: String? = null
         private set