diff --git a/README.md b/README.md index c7dd191..bcdeaab 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,41 @@ # pkgs -PKGBUILDs for running [@tangled.org](https://tangled.org/@tangled.org/core) on [Arch](https://archlinux.org). +PKGBUILDs for running [@tangled.org](https://tangled.org/tangled.org/core) on [Arch](https://archlinux.org). > [!NOTE] > I use these packages to deploy to my knot server. > -> These are **not** official tangled packages. **DO NOT** direct issues using these packages to the core tangled.org repository. +> These are **not** official tangled packages. **DO NOT** direct issues using these PKGSBUILDs to the core tangled.org repository. + +## Required Packages + +The following packages are required to run [update.sh](./update.sh): + +- `git` +- `pacman-contrib` + +Building requires: + +- `fakeroot` +- `go` +- `docker` (spindle only) +- `npm` (appview only) ## Packages: ### [appview](appview) -Builds `appview` from tag [v1.12.0-alpha](https://tangled.org/@tangled.org/core/tree/v1.12.0-alpha). +Builds `appview` from tag [v1.12.0-alpha](https://tangled.org/tangled.org/core/tree/v1.12.0-alpha). ### [knotserver](knotserver) -Builds `knot` from tag [v1.12.0-alpha](https://tangled.org/@tangled.org/core/tree/v1.12.0-alpha). +Builds `knot` from tag [v1.12.0-alpha](https://tangled.org/tangled.org/core/tree/v1.12.0-alpha). ### [knotserver-git](knotserver-git) -Builds `knot` from branch [master](https://tangled.org/@tangled.org/core/tree/master). +Builds `knot` from branch [master](https://tangled.org/tangled.org/core/tree/master). ### [spindle](spindle) -Builds `spindle` from tag [v1.12.0-alpha](https://tangled.org/@tangled.org/core/tree/v1.12.0-alpha). +Builds `spindle` from tag [v1.12.0-alpha](https://tangled.org/tangled.org/core/tree/v1.12.0-alpha). diff --git a/src/README.md.sh b/src/README.md.sh index 09a24cf..94ca088 100644 --- a/src/README.md.sh +++ b/src/README.md.sh @@ -3,29 +3,43 @@ set -eu cat << EOF > ${pkgbuild_path}/README.md # pkgs -PKGBUILDs for running [@tangled.org](https://tangled.org/@tangled.org/core) on [Arch](https://archlinux.org). +PKGBUILDs for running [@tangled.org](https://tangled.org/tangled.org/core) on [Arch](https://archlinux.org). > [!NOTE] > I use these packages to deploy to my knot server. > -> These are **not** official tangled packages. **DO NOT** direct issues using these packages to the core tangled.org repository. +> These are **not** official tangled packages. **DO NOT** direct issues using these PKGSBUILDs to the core tangled.org repository. + +## Required Packages + +The following packages are required to run [update.sh](./update.sh): + +- \`git\` +- \`pacman-contrib\` + +Building requires: + +- \`fakeroot\` +- \`go\` +- \`docker\` (spindle only) +- \`npm\` (appview only) ## Packages: ### [appview](appview) -Builds \`appview\` from tag [v${tag}](https://tangled.org/@tangled.org/core/tree/v${tag}). +Builds \`appview\` from tag [v${tag}](https://tangled.org/tangled.org/core/tree/v${tag}). ### [knotserver](knotserver) -Builds \`knot\` from tag [v${tag}](https://tangled.org/@tangled.org/core/tree/v${tag}). +Builds \`knot\` from tag [v${tag}](https://tangled.org/tangled.org/core/tree/v${tag}). ### [knotserver-git](knotserver-git) -Builds \`knot\` from branch [master](https://tangled.org/@tangled.org/core/tree/master). +Builds \`knot\` from branch [master](https://tangled.org/tangled.org/core/tree/master). ### [spindle](spindle) -Builds \`spindle\` from tag [v${tag}](https://tangled.org/@tangled.org/core/tree/v${tag}). +Builds \`spindle\` from tag [v${tag}](https://tangled.org/tangled.org/core/tree/v${tag}). EOF