ArchLinux README.md: Updated to include documentation and useful info

[Changes]
- Updated README to have documentation from the ArchWiki for Packaging.
- Also Referred to the TDE wiki if known bugs building packages are
  known.
- Wrote useful infomation for building with the script.

Signed-off-by: Shauna Recto <shauna.recto@gmail.com>
arch/build-restructure
Shauna Recto 4 weeks ago
parent 83bae723f4
commit 06d407909e

@ -1,24 +1,58 @@
# Trinity_ArchLinux_PKGBUILD
PKGBUILD's for building Trinity on Arch Linux
# TDE Arch Linux Building and Packaging
## How to build Trinity with these Files
This directory contains all the required scripts to build TDE packages for Arch Linux.
Please acquaint yourself with the build scripts and the PKGBUILDs if you also intend to package the builds.
## Building
If building all the build packages, please run `./build_tde.sh all` which will invoke `makepkg` on all of the PKGBUILDs in the `packages` directory.
Refer to `./build_tde.sh -h` for other
### Building a Single Package
If you have trouble building one of these packages,
please source the environment variables by issuing (from package directory):
please source the environment variables by issuing (from `packages` directory):
```
. ../environment
```
OR
```
# Or:
source ../environment
# Run makgepkg after
```
Note that this is only needed for building individual packages as the `built_tde.sh` script sources `environment` automatically
## Packaging Information
The Build Script build.sh will automatically source this environment and is not needed to be ran beforehand
When verifying that the packages or the PKGBUILDs are good for packaging for distribution,
please familarize yourself with Arch Linux provided documentation.
## Building the Trinity Packages
All you need to do is run ./build.sh after installing any dependencies. A Docker Script is included to create
a temporary build environment for Trinity. It is recommended to use this Docker Environment as this is how
the official trinity arch repo is compiled by. See the README.md in DockerBuildEnvironment for details.
- [Arch Package Guidelines](https://wiki.archlinux.org/title/Arch_package_guidelines)
- [AUR Submission Guidelines](https://wiki.archlinux.org/title/AUR_submission_guidelines)
- [Documentation on `makepkg`](https://wiki.archlinux.org/title/Makepkg)
- [Documentation on `pacman`](https://wiki.archlinux.org/title/Pacman)
- [Documentation on PKGBUILDs](https://wiki.archlinux.org/title/PKGBUILD)
- [DevWiki: Building in a Clean Chroot](https://wiki.archlinux.org/title/DeveloperWiki:Building_in_a_clean_chroot)
- [DevWiki: How to be a Packager](https://wiki.archlinux.org/title/DeveloperWiki:How_to_be_a_packager)
## Unbuildable Packages
## General Tips
### Keep Your System up to Date
You're using a rolling release distro, please ensure you run `# pacman -Syu` as needed.
### Errors With Java
Arch Linux uses OpenJDK as the provider for compiling Java programs and so should be installed on your system.
If needed, please [change the default java enviroment](https://wiki.archlinux.org/title/Java#Change_default_Java_environment) to comply with Java requirements.
### Reforming PKGBUILDs
If you feel like a PKGBUILD needs changes, please refer to the Arch Wiki for guidlines.
Also refer to the [AUR](https://aur.archlinux.org/) for PKGBUILDs currently provided for references on how maintainers use them.
### Unbuildable Packages
Here lists the unbuildable packages at the moment. Please help make these packages buildable and submit any pull
requests to fix them. Each package has a Bug entry which includes the build log for reference.
Also refer to [TDE Module Quirks and Known Bugs](https://wiki.trinitydesktop.org/How_to_Build_TDE_Core_Modules#Quirks_and_Known_Bugs) if a particular package is currently unbuildable.

Loading…
Cancel
Save