From ec6be91aef764dd622c1193cf61b4d5d0e35b064 Mon Sep 17 00:00:00 2001 From: Leonid Pliushch Date: Sat, 8 Jun 2019 14:44:09 +0300 Subject: [PATCH] avoid long lines in README.md --- README.md | 56 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 40 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index ce7475bf2..3fb79038a 100644 --- a/README.md +++ b/README.md @@ -4,33 +4,47 @@ [![Join the chat at https://gitter.im/termux/termux](https://badges.gitter.im/termux/termux.svg)](https://gitter.im/termux/termux) -This project contains scripts and patches to build packages for the [Termux](https://termux.com/) Android application. Note that packages are cross-compiled and on-device builds are not currently supported. +This project contains scripts and patches to build packages for the +[Termux](https://termux.com/) Android application. Note that packages are +cross-compiled and on-device builds are not currently supported. More information can be found in the [docs](docs/) directory. ## Directory Structure -- [disabled-packages](disabled-packages/): Packages that cannot be built or have serious issues. +- [disabled-packages](disabled-packages/): + packages that cannot be built or have serious issues. -- [docs](docs/): Documentation on how to build, formatting etc. +- [docs](docs/): + documentation on how to build, formatting etc. -- [ndk-patches](ndk-patches/): Patches for Android NDK headers. +- [ndk-patches](ndk-patches/): + patches for Android NDK headers. -- [packages](packages/): All currently available packages. +- [packages](packages/): + all currently available packages. -- [scripts](scripts/): Utility scripts for building. +- [scripts](scripts/): + utility scripts for building. ## Issues -The two most common types of issues are package requests and bug reports. There are already templates available. +The two most common types of issues are package requests and bug reports. There +are already templates available. -You can open an issue for any package or build problems. For example, if you observing crashes or other kind of malfunction, you are certainly welcome to file an issue. +You can open an issue for any package or build problems. For example, if you +observing crashes or other kind of malfunction, you are certainly welcome to +file an issue. -Also, if you want to request a particular package, you may suggest it in an issue. However, be prepared that package may not be available shortly. Bugfixes and improvements take precedence over new packages. +Also, if you want to request a particular package, you may suggest it in an +issue. However, be prepared that package may not be available shortly. Bugfixes +and improvements take precedence over new packages. ### Information for Android 7+ users -If your device running Android OS with version 7 and higher, it is highly recommended to check whether your Termux installation uses our new repository with packages compiled specially for higher Android API levels (24+). +If your device running Android OS with version 7 and higher, it is highly +recommended to check whether your Termux installation uses our new repository +with packages compiled specially for higher Android API levels (24+). Execute following command: ``` @@ -40,13 +54,17 @@ It should output the line containing this URL: ``` https://dl.bintray.com/termux/termux-packages-24/ ``` -If not, then it is time to upgrade your installation. This procedure will involve complete erasing of `$PREFIX`, directory where all packages are installed (aka rootfs) but your home directory will be untouched. +If not, then it is time to upgrade your installation. This procedure will +involve complete erasing of `$PREFIX`, directory where all packages are +installed (aka rootfs) but your home directory will be untouched. So if you decided to upgrade your installation, do the following steps: 1. Ensure that application's version is v0.67 or higher. If not - upgrade. -2. Move all important files, e.g. configs, databases, custom scripts, etc to your `$HOME` (temporarily). Also, save the list of packages that you will need to reinstall. +2. Move all important files, e.g. configs, databases, custom scripts, etc to + your `$HOME` (temporarily). Also, save the list of packages that you will + need to reinstall. 3. Execute `rm -rf $PREFIX`. @@ -56,11 +74,15 @@ So if you decided to upgrade your installation, do the following steps: ## Pull Requests -We welcome any pull requests. Nevertheless, a log file should be provided in order to show that it is at least working. +We welcome any pull requests. Nevertheless, a log file should be provided in +order to show that it is at least working. -All pull requests will be built by [Cirrus CI](https://cirrus-ci.com/termux/termux-packages). Usually, it is expected that all tasks will pass. But do not worry if CI build timed out. Alternatively, you can provide build logs by yourself. +All pull requests will be built by [Cirrus CI](https://cirrus-ci.com/termux/termux-packages). +Usually, it is expected that all tasks will pass. But do not worry if CI build +timed out. Alternatively, you can provide build logs by yourself. -Note that it is highly recommended to keep your pull requests up-to-date. If you do not know how to do this, take a look on manpage of `git-rebase`. +Note that it is highly recommended to keep your pull requests up-to-date. If +you do not know how to do this, take a look on manpage of `git-rebase`. ## Contacts @@ -70,4 +92,6 @@ Note that it is highly recommended to keep your pull requests up-to-date. If you - Developer Chat: https://gitter.im/termux/dev or #termux/development on IRC/freenode. -If you are interested in our weekly development sessions, please check the https://wiki.termux.com/wiki/Dev:Development_Sessions. Also, you may want to check the https://wiki.termux.com/wiki/Development. +If you are interested in our weekly development sessions, please check the +https://wiki.termux.com/wiki/Dev:Development_Sessions. Also, you may want to +check the https://wiki.termux.com/wiki/Development.