From 9b2f1d76ccf5717f53cfa12d677a551f04fd5397 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9C=88=E5=AD=A3=E8=8A=B1=E4=B8=AD=E7=9A=84=E6=98=9F?= =?UTF-8?q?=E8=BE=B0?= Date: Mon, 23 Aug 2021 20:43:25 +0800 Subject: [PATCH] Create CONTRIBUTING_EN.md --- CONTRIBUTING_EN.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 CONTRIBUTING_EN.md diff --git a/CONTRIBUTING_EN.md b/CONTRIBUTING_EN.md new file mode 100644 index 0000000000..3102a57a62 --- /dev/null +++ b/CONTRIBUTING_EN.md @@ -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).