termux-packages/README.md

127 lines
4.2 KiB
Markdown
Raw Normal View History

2019-02-12 02:44:10 +01:00
# Termux packages
2020-01-22 20:35:34 +01:00
[![Packages last build status](https://github.com/termux/termux-packages/workflows/Packages/badge.svg)](https://github.com/termux/termux-packages/actions)
[![Docker image status](https://github.com/termux/termux-packages/workflows/Docker%20image/badge.svg)](https://hub.docker.com/r/termux/package-builder)
[![Repology metadata status](https://github.com/termux/termux-packages/workflows/Repology%20metadata/badge.svg)](https://repology.org/repository/termux)
2016-01-13 01:29:13 +01:00
[![Join the chat at https://gitter.im/termux/termux](https://badges.gitter.im/termux/termux.svg)](https://gitter.im/termux/termux)
2016-01-13 01:28:47 +01:00
2020-01-22 20:35:34 +01:00
[![Powered by JFrog Bintray](./.github/static/powered-by-bintray.png)](https://bintray.com)
2019-09-22 17:28:44 +02:00
This project contains scripts and patches to build packages for the [Termux]
Android application.
2015-06-13 01:03:17 +02:00
The packages available here are only from main set. We have some additional
2019-09-22 17:28:44 +02:00
repositories:
2019-09-22 17:28:44 +02:00
- https://github.com/termux/game-packages
2019-10-04 12:50:14 +02:00
Game packages, e.g. `angband` or `moon-buggy`.
2019-09-22 17:28:44 +02:00
- https://github.com/termux/science-packages
2019-10-04 12:50:14 +02:00
Science-related packages like `gap` and `gnucap`.
2019-09-22 17:28:44 +02:00
- https://github.com/termux/termux-root-packages
Packages which can be used only on rooted devices. Some stuff available
here requires custom kernel (like `aircrack-ng` or `lxc`).
2019-09-22 17:28:44 +02:00
- https://github.com/termux/unstable-packages
Staging repository. Packages that are not stable are only available here.Most likely, new packages will also be placed here.
2019-09-22 17:28:44 +02:00
- https://github.com/termux/x11-packages
Packages that require X11 Windows System.
2019-09-22 17:28:44 +02:00
Termux package management quick how-to available on https://wiki.termux.com/wiki/Package_Management.
To learn about using our build environment, read the [Developer's Wiki].
## Project structure
Directories:
2019-02-12 02:56:43 +01:00
2019-06-08 13:44:09 +02:00
- [disabled-packages](disabled-packages/):
2019-02-12 02:56:43 +01:00
2019-10-04 12:50:14 +02:00
Packages that cannot be published due to serious issues.
2019-02-12 02:56:43 +01:00
2019-06-08 13:44:09 +02:00
- [ndk-patches](ndk-patches/):
2019-09-22 17:28:44 +02:00
2019-10-04 12:50:14 +02:00
Our changes to Android NDK headers.
2019-02-12 02:56:43 +01:00
2019-06-08 13:44:09 +02:00
- [packages](packages/):
2019-09-22 17:28:44 +02:00
2019-10-04 12:50:14 +02:00
Main set of packages.
2019-09-22 17:28:44 +02:00
- [sample](sample/):
2019-10-04 12:50:14 +02:00
Sample structure for creating new packages.
2019-02-12 02:56:43 +01:00
2019-06-08 13:44:09 +02:00
- [scripts](scripts/):
2019-02-12 02:56:43 +01:00
2019-10-04 12:50:14 +02:00
Set of utilities and build system scripts.
2019-09-22 17:28:44 +02:00
## Contributing
### Bug reports
2019-02-12 05:48:04 +01:00
2019-09-22 17:28:44 +02:00
Please, use templates for submitting bug reports. The *bug report* issue template
can be initialized by clicking on https://github.com/termux/termux-packages/issues/new?template=bug_report.md.
2019-02-12 05:48:04 +01:00
2019-09-22 17:28:44 +02:00
General requirements for bug reports are:
2019-02-12 05:48:04 +01:00
2019-09-22 17:28:44 +02:00
- All packages are up-to-date.
2019-02-12 05:48:04 +01:00
2019-09-22 17:28:44 +02:00
- Problem is not related to third-party software.
2019-05-16 02:55:48 +02:00
2019-09-22 17:28:44 +02:00
- Output of `termux-info` attached.
2019-05-16 02:55:48 +02:00
2019-09-22 17:28:44 +02:00
- Be ready to provide more info if requested.
2019-05-16 02:55:48 +02:00
2019-09-22 17:28:44 +02:00
### New packages
2019-05-16 02:55:48 +02:00
2019-09-22 17:28:44 +02:00
Use the *package request* template: https://github.com/termux/termux-packages/issues/new?template=package_request.md.
2019-05-16 02:55:48 +02:00
2019-09-22 17:28:44 +02:00
General requirements for new packages are:
2019-05-16 02:55:48 +02:00
2019-09-22 17:28:44 +02:00
- Packages should be open source and have widely recognised OSS licenses like
GNU GPL.
2019-05-16 02:55:48 +02:00
2019-09-22 17:28:44 +02:00
- Packages should not be installable via language-specific package managers such
as `gem`, `pip` or `cpan`.
2019-05-16 02:55:48 +02:00
2019-09-22 17:28:44 +02:00
- Packages should not be outdated dead projects.
- Be ready that your package request will not be processed immediately.
2019-05-16 02:55:48 +02:00
2019-02-12 05:48:04 +01:00
## Pull Requests
2019-09-22 17:28:44 +02:00
All pull requests are welcome.
2020-02-07 14:41:38 +01:00
We use [Github Actions](https://github.com/termux/termux-packages/actions) for processing
all pushes including pull requests. All build logs and artifacts are public, so you can
verify whether your changes work properly.
2019-02-12 05:48:04 +01:00
2019-09-22 17:28:44 +02:00
People who are new for packaging can begin with sending PRs for updating
packages. Check the outdated packages on https://repology.org/projects/?inrepo=termux&outdated=1.
2019-02-12 05:48:04 +01:00
2019-09-22 17:28:44 +02:00
Get started with information available on [Developer's Wiki].
2019-02-13 06:10:22 +01:00
2019-02-23 15:18:27 +01:00
## Contacts
2019-02-13 06:10:22 +01:00
2019-02-23 15:18:27 +01:00
- General Mailing List: https://groups.io/g/termux
2019-02-13 06:10:22 +01:00
2019-02-23 15:18:27 +01:00
- Developer Mailing List: https://groups.io/g/termux-dev
- Developer Chat: https://gitter.im/termux/dev or #termux/development on IRC/freenode.
2019-06-08 13:44:09 +02:00
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.
2019-09-22 17:28:44 +02:00
[Bintray]: <https://bintray.com/termux/termux-packages-24>
[Developer's Wiki]: <https://github.com/termux/termux-packages/wiki>
[Termux]: <https://github.com/termux/termux-app>
[android-5]: <https://github.com/termux/termux-packages/tree/android-5>
[master]: <https://github.com/termux/termux-packages/tree/master>