Browse Source

Add Android Termux installation instructions

timvisee 5 years ago
parent
commit
1082df1d2c
1 changed files with 19 additions and 1 deletions
  1. 19 1
      README.md

+ 19 - 1
README.md

@@ -31,7 +31,7 @@ Find out more about security [here](#security).
 - [Features](#features)
 - [Features](#features)
 - [Usage](#usage)
 - [Usage](#usage)
 - [Requirements](#requirements)
 - [Requirements](#requirements)
-- [Install](#install) ([Linux](#linux-all-distributions), [macOS](#macos), [Windows](#windows), [FreeBSD](#freebsd), [_Other OS/arch_](#other-os-or-architecture))
+- [Install](#install) ([Linux](#linux-all-distributions), [macOS](#macos), [Windows](#windows), [FreeBSD](#freebsd), [Android](#android), [_Other OS/arch_](#other-os-or-architecture))
 - [Build](#build)
 - [Build](#build)
 - [Configuration and environment](#configuration-and-environment)
 - [Configuration and environment](#configuration-and-environment)
 - [Security](#security)
 - [Security](#security)
@@ -149,6 +149,8 @@ all available subcommands.
   - OpenSSL: `pkg install openssl`
   - OpenSSL: `pkg install openssl`
   - CA certificates: `pkg install ca_root_nss`
   - CA certificates: `pkg install ca_root_nss`
   - Optional `xclip` & `xsel` for clipboard support: `pkg install xclip xsel-conrad`
   - Optional `xclip` & `xsel` for clipboard support: `pkg install xclip xsel-conrad`
+- Android specific:
+  - Termux: [» Termux][termux]
 
 
 ## Install
 ## Install
 Because `ffsend` is still in alpha, only limited installation options are
 Because `ffsend` is still in alpha, only limited installation options are
@@ -161,6 +163,7 @@ See the operating system specific instructions below:
 - [macOS](#macos)
 - [macOS](#macos)
 - [Windows](#windows)
 - [Windows](#windows)
 - [FreeBSD](#freebsd)
 - [FreeBSD](#freebsd)
+- [Android](#android)
 - [_Other OS or architecture_](#other-os-or-architecture)
 - [_Other OS or architecture_](#other-os-or-architecture)
 
 
 ### Linux (all distributions)
 ### Linux (all distributions)
@@ -374,6 +377,20 @@ pkg install ffsend
 cd /usr/ports/www/ffsend && make install
 cd /usr/ports/www/ffsend && make install
 ```
 ```
 
 
+### Android
+`ffsend` can be used on Android through Termux, install it first:
+[» Termux][termux]
+
+_Note: The Android package is currently maintained by Termux contributors,
+and might be slightly outdated._
+
+```sh
+# Install package.
+pkg install ffsend
+
+ffsend help
+```
+
 ### Other OS or architecture
 ### Other OS or architecture
 If your system runs Docker, you can use the [docker image](#docker-image).
 If your system runs Docker, you can use the [docker image](#docker-image).
 There are currently no other binaries or packages available.
 There are currently no other binaries or packages available.
@@ -780,6 +797,7 @@ Check out the [LICENSE](LICENSE) file for more information.
 [mozilla]: https://mozilla.org/
 [mozilla]: https://mozilla.org/
 [openssl]: https://www.openssl.org/
 [openssl]: https://www.openssl.org/
 [openssl-windows-installer]: https://u.visee.me/dl/openssl/Win64OpenSSL_Light-1_1_0j.exe
 [openssl-windows-installer]: https://u.visee.me/dl/openssl/Win64OpenSSL_Light-1_1_0j.exe
+[termux]: https://termux.com/
 [rust]: https://rust-lang.org/
 [rust]: https://rust-lang.org/
 [rustup]: https://rustup.rs/
 [rustup]: https://rustup.rs/
 [send]: https://send.firefox.com/
 [send]: https://send.firefox.com/