From e89623e163fbc64d25c8d52042f15e21e1dd4e95 Mon Sep 17 00:00:00 2001 From: Jakob Meier Date: Sat, 8 Oct 2022 12:26:35 +0200 Subject: [PATCH] updated building instructions --- README.org | 125 +++++++++++++++++++++++++++++++++-------------------- 1 file changed, 78 insertions(+), 47 deletions(-) diff --git a/README.org b/README.org index 7cb836c..244c9ac 100644 --- a/README.org +++ b/README.org @@ -12,59 +12,89 @@ and pull requests on other platforms will be ignored. 1. Most of my projects are not popular enough for me to publish them 2. If I were to publish them, I'd have to commit to maintaining the APKBUILD and the project. And I can't be bothered. -** How to install a project from here? -1. Clone this git repo - #+begin_src bash - git clone https://codeberg.org/comcloudway/apks ccw-repo - cd ccw-repo - #+end_src -2. Find the project you want to build. - There aren't many projects in here (yet). - - But assuming you want to build ~polarplayer-studio~, - you can use the following commands (replace ~polarplayer-studio~ with the name of project you want to build) - - #+begin_src bash - cd polarplayer-studio - abuild -r - #+end_src -3. After the build finished, - you should be able to find - that ~abuild~ generated a repo in ~$HOME/packages/ccw-repo~. - - Depending on the architecture of your computer, - the build output can now be found in ~$HOME/packages/ccw-repo/$arch~. - Most computers probably use the ~x86_64~ architecture, - but when you are building this on a pinephone it should be ~aarch64~. - - In case you do not know your architecture, - you are in luck, - because you do not have to, - as ~apk~ will take care of this for you. - - To install the package you build you can use the following command: - #+begin_src bash - apk add --repository $HOME/packages/ccw-repo polarplayer-studio - #+end_src -4. Congratualtions! - You've installed a program from my repo. - ** Will you make prebuild binaries available? Maybe. -You can find my public key [[./comcloudway@ccw.icu.rsa.pub][here]] +For now you will have to build the projects yourself. +Instructions for doing so can be found in the next chapter. + +In case I ever publish prebuild binaries: +you can find my public key [[./comcloudway@ccw.icu.rsa.pub][here]]. + +** Building packages using the APKBUILDs +Before you start building the packages, +you have to setup your developement environment. +The following two links might be helpful for that: +- [[https://wiki.alpinelinux.org/wiki/APKBUILD_Reference][APKBUILD ref]] +- [[https://wiki.alpinelinux.org/wiki/Creating_an_Alpine_package][Creating an alpine package]] + +After you finishes setting up your system, +we can move on. + +First of all, +we need to clone this repo. +#+begin_src bash +git clone https://codeberg.org/comcloudway/ccw-aports +#+end_src + +To make the process easier, +you can use the ~build.sh~ to build: + - everything + - one subrepo + - one package + +You can find out more about these build options below. + +When you finished building the packages, +the build output can be found +in ~$HOME/packages/ccw-aports//.apk~. + +To install a package from your build repo, +either add the path to the subrepo +(~$HOME/packages/ccw-aports/~) to ~/etc/apk/repositories~, +or run the following command to install packages from the repo, +replacing ~~ with the name of the subrepo, +and replcaing ~~ with the name of the package. +#+begin_src bash +apk add -X $HOME/packages/ccw-aports/ +#+end_src + +*** Building everything +To build every subrepo (expect ~broken~), +simply run; + +#+begin_src bash +./build.sh all +#+end_src +*** Building one subrepo +If you want to build all packages from a specific subrepo, +run the following command replacing ~~, +with the subrepo of your choice, +e.g. ~main~. +#+begin_src bash +./build.sh repo +#+end_src +*** Building one package +If you want to build a specific package from a specific subrepo, +you can run the following command, +replacing ~~ with the subrepo of your choice, +and ~~ with the package of your choice. +#+begin_src bash +./build.sh +#+end_src + +For example: +#+begin_src bash +./build.sh main blueprint +#+end_src ** HELP! Something isn't working. -That might happen - yeah, -now that you say it, -it is likely that something doesn't work properly. - Before you ~panic!~, please check the according projects README, just in case you've missed something. But if you are certain that the problem is related to the ~APKBUILD~, -please file an issue on codeberg. +please file an issue on [[https://codeberg.org/comcloudway/ccw-aports][codeberg]]. ** License All the APKBUILDs in this repo are licensed under MIT unless noted otherwise. @@ -76,7 +106,8 @@ the MIT might not apply to the projects themselves. * Useful resources The following list is inpired by the [[https://gitlab.com/postmarketOS/pmaports][pmaports repo]] -- [[https://wiki.postmarketos.org/wiki/Create_a_package][How to create a package]] -- [[https://wiki.alpinelinux.org/wiki/APKBUILD_Reference][APKBUILD ref]] -- [[https://gitlab.alpinelinux.org/alpine/aports/][Alpine Linux aports]] -- [[https://pkgs.alpinelinux.org/packages][Alpine Linux package search]] +- [[https://wiki.postmarketos.org/wiki/Create_a_package][How to create a package]] +- [[https://wiki.alpinelinux.org/wiki/APKBUILD_Reference][APKBUILD ref]] +- [[https://wiki.alpinelinux.org/wiki/Creating_an_Alpine_package][Creating an alpine package]] +- [[https://gitlab.alpinelinux.org/alpine/aports/][Alpine Linux aports]] +- [[https://pkgs.alpinelinux.org/packages][Alpine Linux package search]] -- 2.38.5