update README.md

docs/build.md

@@ -0,0 +1,40 @@
+# Building µLauncher
+
+## Using the command line
+
+Install JDK 17 and the Android Sdk.
+Make sure that `JAVA_HOME` and `ANDROID_HOME` are set correctly.
+
+```
+git clone https://github.com/jrpie/Launcher
+cd Launcher
+
+./gradlew assembleDefaultRelease
+```
+
+This will create an apk file at `app/build/outputs/apk/default/release/app-default-release-unsigned.apk`.
+
+Note that you need to sign it:
+```
+apksigner sign --ks "$YOUR_KEYSTORE" \
+    --ks-key-alias "$YOUR_ALIAS" \
+    --ks-pass="pass:$YOUR_PASSWORD" \
+    --key-pass="pass:$YOUR_PASSWORD" \
+    --alignment-preserved \
+    --v1-signing-enabled=true \
+    --v2-signing-enabled=true \
+    --v3-signing-enabled=true \
+    --v4-signing-enabled=true \
+    app-default-release-unsigned.apk
+```
+
+
+See [this guide](https://developer.android.com/build/building-cmdline)
+for further instructions.
+
+
+## Using Android Studio
+Install [Android Studio](https://developer.android.com/studio), import this project and build it.
+
+See [this guide](https://developer.android.com/studio/run)
+for further instructions.

docs/launcher.md

@@ -0,0 +1,49 @@
+# Notable changes compared to [Finn's Launcher][original-repo]:
+
+µLauncher is a fork of [finnmglas's app Launcher][original-repo].
+Here is an incomplete list of changes:
+<!--The last commit of the original project is [340ee731](https://github.com/jrpie/launcher/commit/340ee7315293b028c060638e058516435bca296a)
+The first commit of µLauncher is [cc2e7710](https://github.com/jrpie/launcher/commit/cc2e7710c824549c367d97a81a1646d27c6c8993),
+which at the time was still intended as a patch for launcher.
+The decision to create a hard fork was made two years later.-->
+
+
+- Additional gestures:
+    - Back
+    - V,Λ,<,>
+    - Edge gestures: There is a setting to allow distinguishing swiping at the edges of the screen from swiping in the center.
+- Compatible with [work profile](https://www.android.com/enterprise/work-profile/), so apps like [Shelter](https://gitea.angry.im/PeterCxy/Shelter) can be used.
+- Compatible with [private space](https://source.android.com/docs/security/features/private-space)
+- Option to rename apps
+- Option to hide apps
+- Favorite apps
+- New actions:
+  - Toggle Torch
+  - Lock screen
+- The home button now works as expected.
+- Improved gesture detection.
+
+### Visual
+- This app uses the system wallpaper instead of a custom solution.
+- The font has been changed to [Hack][hack-font], other fonts can be selected.
+- Font Awesome Icons were replaced by Material icons.
+- The gear button on the home screen was removed. A smaller button is show at the top right when necessary.
+
+
+### Search
+- The search algorithm was modified to prefer matches at the beginning of the app name, i.e. when searching for `"te"`, `"termux"` is sorted before `"notes"`.
+- The search bar was moved to the bottom of the screen.
+
+### Technical
+- Improved gesture detection.
+- Different apps set as default.
+- Package name was changed to `de.jrpie.android.launcher` to avoid clashing with the original app.
+- Dropped support for API < 21 (i.e. pre Lollypop)
+- Fixed some bugs
+- Some refactoring
+
+
+The complete list of changes can be viewed [here](https://github.com/jrpie/launcher/compare/340ee731...master).
+
+---
+  [original-repo]: https://github.com/finnmglas/Launcher