Clean README.

README.md

@@ -1,44 +1,41 @@
-# borgbackup on android
+# BorgBackup on Android
-This project provides build scripts to compile borgbackup (https://github.com/borgbackup/borg) and its dependencies on Android. It uses termux (https://termux.com/) as a lightweight environment. 
+Forked from [ravenschade/borgbackup_on_android](https://github.com/ravenschade/borgbackup_on_android)
+with modifications from [GAhlekzis](https://github.com/GAhlekzis/borgbackup_on_android).
 
-Yoou don't root permission on your phone to use it. However without root permissions the access to data of other apps or system data is not possible, but you can still access your photos, videos,...
 
-If you have root permission on your device, you can use tsu (https://github.com/cswl/tsu) to conveniently gain root permissions in termux and backup you complete device.
+## Introduction
+This project provides build scripts to compile [BorgBackup](https://github.com/borgbackup/borg) and its dependencies on
+Android. It uses  [Termux](https://termux.com/) as a lightweight environment.
 
-How to use:
+You do not need root permission on your phone to use it. However, without root permissions the access to data of other
- - install termux from F-Droid or Google Play (https://termux.com/)
+apps or system data is not possible, but you can still access your photos, videos.
- - open app
- - run "apt update; apt install git"
- - run "git clone https://github.com/ravenschade/borgbackup_on_android.git"
- - run "cd borgbackup_on_android; bash build.sh"
- - (if virtualenv for python does not work properly you have to set selinux to permissive (do "/system/bin/setenforce 0" with root permissions))
 
-Known issues:
+If you have root permission on your device, you can use the "sudo" of Termux, [tsu](https://github.com/cswl/tsu), to
- - borg starting at 1.1 requires the system call sync_file_range (see https://github.com/borgbackup/borg/pull/985 and https://github.com/borgbackup/borg/issues/1961). The linux subsystem in Windows 10 and some older Android versions (for example Lineage including 14.1) do not yet have this. Lineage 15.0 has this call and should work. I have added a test to the build script that checks if sync_file_range is available. If it is not, then I apply a patch (borg_sync_file_range.patch) that replaces this sync with convential file syncs.
+conveniently gain root permissions in Termux and backup your complete device.
+
+
+## Installation
+Install [Termux](https://f-droid.org/en/packages/com.termux/) from F-Droid, open it, and execute the following:
+```bash
+pkg install git
+git clone https://git.caspervk.net/caspervk/borgbackup_on_android
+cd borgbackup_on_android
+bash build.sh
+```
+If virtualenv for Python does not work properly set selinux to permissive (`tsudo /system/bin/setenforce 0`).
+
+Warning messages like 
+```
+WARNING: linker: /data/data/com.termux/files/usr/lib/libacl.so.1.1.0: unused DT entry: type 0xf arg 0x449
+```
+are due to the Android linker. More details can be found at https://stackoverflow.com/questions/33206409/unused-dt-entry-type-0x1d-arg.
 
 Tested with:
 - termux 0.56
 - borg 1.0.12, 1.1.3
 
-Tested and working so far is:
-- creation of repositories 
-- backup to repositories on the device
-- backup up to remote repositories via ssh
-
-Tested and working on devices:
-- OnePlus 6 with stock Android 9 (aarch64)
-- Huawei Nexus6p with stock Android 8.1.0 (angler, aarch64)
-- Samsung Galaxy Note 2 with Lineage 14.1 (n7100, armv7l, Android 7.1.1)
-
-Feedback on tests with other devices and android versions is very welcome.
-
-Warning messages like 
-````
-WARNING: linker: /data/data/com.termux/files/usr/lib/libacl.so.1.1.0: unused DT entry: type 0xf arg 0x449
-````
-are due to the Android linker. More details can be found at https://stackoverflow.com/questions/33206409/unused-dt-entry-type-0x1d-arg.
-
 
+## Configuration
 So all in all my Android backup setup looks like:
 - borg, termux and tasker
 - termux: Task (https://f-droid.org/packages/com.termux.tasker/) for tasker integration
@@ -55,8 +52,6 @@ read
 ```bash
 #!/data/data/com.termux/files/usr/bin/bash
 t=`date +%d_%m_%Y`
-# export BORG_UNKNOWN_UNENCRYPTED_REPO_ACCESS_IS_OK=yes
-export BORG_RELOCATED_REPO_ACCESS_IS_OK=yes
 host=angler
 dirs="/ /system /vendor /cache /persist /firmware /storage /data"
 export BORG_RSH=borg_ssh_wrapper
@@ -65,3 +60,11 @@ borg create -C lz4 -p -v --stats --one-file-system backup:/backup/borg/$host::fi
 ```
 
 Dont forget to set ssh configs accordingly!
+
+
+## Known Issues
+Borg starting at 1.1 requires the system call sync_file_range (see https://github.com/borgbackup/borg/pull/985 and
+https://github.com/borgbackup/borg/issues/1961). The linux subsystem in Windows 10 and some older Android versions (for
+example Lineage including 14.1) do not yet have this. Lineage 15.0 has this call and should work. I have added a test to
+the build script that checks if sync_file_range is available. If it is not, then I apply a patch
+(borg_sync_file_range.patch) that replaces this sync with conventional file syncs.