BioArchLinux/Packages
2
0
Fork 0
mirror of https://github.com/BioArchLinux/Packages.git synced 2025-03-10 12:02:42 +00:00
Code Issues Projects Releases Packages Wiki Activity

Create CONTRIBUTING_EN.md

Browse source
This commit is contained in:
月季花中的星辰 2021-08-23 20:43:25 +08:00 • committed by GitHub
parent 906d434214
commit 9b2f1d76cc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
CONTRIBUTING_EN.md Normal file
View file

@ -0,0 +1,23 @@
# Contribution
## lilac
Packages Repository is built by lilac. The lilac allows user to auto-update the packages via lilac related files, such as `lilac.yaml` and `lilac.py`. Also, it can develop repository like what AUR did, using PKGBUILD
## PKGBUILD
The PKGBUILD writing guide is give by [PKGBUILD page](https://wiki.archlinux.org/title/PKGBUILD) on ArchWiki, you can find different ways to write PKGBUILD developed by coding language.
Also, you can refer to the [AUR](https://wiki.archlinux.org/title/PKGBUILD) if you are a beginner. And the [Arch Forum](https://bbs.archlinux.org/) and our [discussions](https://github.com/BioArchLinux/Packages/discussions) would be a great place to discuss the related issues.
## `lilac.yaml`
`lilac.yaml` is the required file for lilac. The regular [writing guide](https://archlinuxcn.github.io/lilac/) is provided by archlinuxcn. API is listed [here](https://lilac.readthedocs.io/en/latest/api.html) and Q&A is posted [here](https://wiki.archlinuxcn.org/wiki/Lilac_%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98#%E6%9B%B4%E6%96%B0_AUR) by wiki of archlinuxcn.
For the lilac.yaml writing, please refer the [archlinuxcn repo](https://github.com/archlinuxcn/repo) and the [arch4edu repo](https://github.com/arch4edu/arch4edu).
## `lilac.py`
`lilac.py` is not the necessary file for lilac. The writing guide for `lilac.py` is provided by [archlinuxcn wiki](https://wiki.archlinuxcn.org/wiki/Lilac.py).
For the lilac.py writing, please refer the [archlinuxcn repo](https://github.com/archlinuxcn/repo) and the [arch4edu repo](https://github.com/arch4edu/arch4edu).