update LICENSE.md & README.md (reformat)

This commit is contained in:
Leonid Plyushch 2019-07-15 17:36:03 +03:00
parent aecf0aabcb
commit 994f265100
No known key found for this signature in database
GPG Key ID: 45F2964132545795
2 changed files with 37 additions and 18 deletions

View File

@ -1,10 +1,11 @@
# License for package patches
The scripts and patches to build each package is licensed under the same license as
the actual package (so the patches and scripts to build bash are licensed under
the same license as bash, while the patches and scripts to build python are licensed
under the same license as python).
The scripts and patches to build each package is licensed under the same
license as the actual package (so the patches and scripts to build bash are
licensed under the same license as bash, while the patches and scripts to build
python are licensed under the same license as python).
# License for the build infrastructure
For build infrastructure outside the `packages/` folder the license is [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).
For build infrastructure outside the `packages/` folder the license is
[Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).

View File

@ -4,37 +4,53 @@
[![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.
## 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
@ -44,4 +60,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.