From fe832c97b2a76cec9c8183ff950fc14df163778a Mon Sep 17 00:00:00 2001 From: Elara Musayelyan Date: Wed, 20 Sep 2023 20:22:02 -0700 Subject: [PATCH] Update docs --- docs/configuration.md | 2 +- docs/packages/adding-packages.md | 6 +++--- docs/packages/build-scripts.md | 8 ++++---- docs/usage.md | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index 9771332..089b7d6 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -36,7 +36,7 @@ The `repo` array in the config specifies which repos are added to LURE. Each rep ```toml [[repo]] name = 'default' -url = 'https://github.com/Arsen6331/lure-repo.git' +url = 'https://github.com/Elara6331/lure-repo.git' ``` The `default` repo is added by default. Any amount of repos may be added. diff --git a/docs/packages/adding-packages.md b/docs/packages/adding-packages.md index 5f91485..55ecdeb 100644 --- a/docs/packages/adding-packages.md +++ b/docs/packages/adding-packages.md @@ -5,7 +5,7 @@ - `go` (1.18+) - `git` - `lure-analyzer` - - `go install go.arsenm.dev/lure-repo-bot/cmd/lure-analyzer@latest` + - `go install go.elara.ws/lure-repo-bot/cmd/lure-analyzer@latest` - `shfmt` - May be available in distro repos - `go install mvdan.cc/sh/v3/cmd/shfmt@latest` @@ -18,9 +18,9 @@ To test packages you can first create [a `lure.sh` shell file](./build-scripts.m ## How to submit a package -LURE's repo is hosted on Github at https://github.com/Arsen6331/lure-repo. In it, there are multiple directories each containing a `lure.sh` file. In order to add a package to LURE's repo, simply create a PR with a [build script](./build-scripts.md) and place it in a directory with the same name as the package. +LURE's repo is hosted on Github at https://github.com/Elara6331/lure-repo. In it, there are multiple directories each containing a `lure.sh` file. In order to add a package to LURE's repo, simply create a PR with a [build script](./build-scripts.md) and place it in a directory with the same name as the package. -Upon submitting the PR, [lure-repo-bot](https://github.com/Arsen6331/lure-repo-bot) will pull your PR and analyze it, providing suggestions for fixes as review comments. If there are no problems, the bot will approve your changes. If there are issues, re-request review from the bot after you've finished applying the fixes and it will automatically review the PR again. +Upon submitting the PR, [lure-repo-bot](https://github.com/Elara6331/lure-repo-bot) will pull your PR and analyze it, providing suggestions for fixes as review comments. If there are no problems, the bot will approve your changes. If there are issues, re-request review from the bot after you've finished applying the fixes and it will automatically review the PR again. All scripts submitted to the LURE repo should be formatted with `shfmt`. If they are not properly formatted, Github Actions will add suggestions in the "Files Changed" tab of the PR. diff --git a/docs/packages/build-scripts.md b/docs/packages/build-scripts.md index 7c90f92..a5f2f68 100644 --- a/docs/packages/build-scripts.md +++ b/docs/packages/build-scripts.md @@ -55,7 +55,7 @@ LURE uses build scripts similar to the AUR's PKGBUILDs. This is the documentatio ## Distro Overrides -Allowing LURE to run on different distros provides some challenges. For example, some distros use different names for their packages. This is solved using distro overrides. Any variable or function used in a LURE build script may be overridden based on distro and CPU architecture. The way you do this is by appending the distro and/or architecture to the end of the name. For example, [ITD](https://gitea.arsenm.dev/Arsen6331/itd) depends on the `pactl` command as well as DBus and BlueZ. These are named somewhat differently on different distros. For ITD, I use the following for the dependencies: +Allowing LURE to run on different distros provides some challenges. For example, some distros use different names for their packages. This is solved using distro overrides. Any variable or function used in a LURE build script may be overridden based on distro and CPU architecture. The way you do this is by appending the distro and/or architecture to the end of the name. For example, [ITD](https://gitea.elara.ws/Elara6331/itd) depends on the `pactl` command as well as DBus and BlueZ. These are named somewhat differently on different distros. For ITD, I use the following for the dependencies: ```bash deps=('dbus' 'bluez' 'pulseaudio-utils') @@ -118,7 +118,7 @@ The `homepage` field contains the URL to the website of the project packaged by The `maintainer` field contains the name and email address of the person maintaining the package. Example: ```text -Arsen Musayelyan +Elara Musayelyan ``` While LURE does not require this field to be set, Debian has deprecated unset maintainer fields, and may disallow their use in `.deb` packages in the future. @@ -202,11 +202,11 @@ If the URL scheme starts with `git+`, the source will be downloaded as a git rep Examples: ```text -git+https://gitea.arsenm.dev/Arsen6331/itd?~rev=resource-loading&~depth=1 +git+https://gitea.elara.ws/Elara6331/itd?~rev=resource-loading&~depth=1 ``` ```text -git+https://gitea.arsenm.dev/Arsen6331/lure?~rev=v0.0.1&~recursive=true +git+https://gitea.elara.ws/Elara6331/lure?~rev=v0.0.1&~recursive=true ``` ### checksums diff --git a/docs/usage.md b/docs/usage.md index 68009de..39c5d6a 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -117,7 +117,7 @@ The addrepo command adds a repository to LURE if it doesn't already exist. The ` Example: ```shell -lure ar -n default -u https://github.com/Arsen6331/lure-repo +lure ar -n default -u https://github.com/Elara6331/lure-repo ``` ### removerepo