From 1742672ebfb1c6bf8d3add133ce5e73ba05ea3e8 Mon Sep 17 00:00:00 2001 From: godalming123 Date: Fri, 28 Apr 2023 17:06:34 +0100 Subject: [PATCH 1/2] Add a description of how to test a package --- docs/packages/adding-packages.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/packages/adding-packages.md b/docs/packages/adding-packages.md index 3f19d39..c32b8ae 100644 --- a/docs/packages/adding-packages.md +++ b/docs/packages/adding-packages.md @@ -12,6 +12,10 @@ --- +## How to test a package + +To test packages you can first create [a `lure.sh` shell file](./build-scripts.md) and then run the `lure build` comand to build the local `lure.sh` file into a install file for your OS (more info about the `build` command [here](./usage.md#build) you can then install this file to your distro and test it. + ## 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. @@ -20,4 +24,4 @@ Upon submitting the PR, [lure-repo-bot](https://github.com/Arsen6331/lure-repo-b 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. -Once your PR is merged, LURE will pull the changed repo and your package will be available for people to install. \ No newline at end of file +Once your PR is merged, LURE will pull the changed repo and your package will be available for people to install. From 1fd027878fdb14e935db8b069173777a094806a8 Mon Sep 17 00:00:00 2001 From: godalming123 Date: Wed, 3 May 2023 16:43:37 +0100 Subject: [PATCH 2/2] Fix some grammer Co-authored-by: Elara Musayelyan --- docs/packages/adding-packages.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/packages/adding-packages.md b/docs/packages/adding-packages.md index c32b8ae..5f91485 100644 --- a/docs/packages/adding-packages.md +++ b/docs/packages/adding-packages.md @@ -14,7 +14,7 @@ ## How to test a package -To test packages you can first create [a `lure.sh` shell file](./build-scripts.md) and then run the `lure build` comand to build the local `lure.sh` file into a install file for your OS (more info about the `build` command [here](./usage.md#build) you can then install this file to your distro and test it. +To test packages you can first create [a `lure.sh` shell file](./build-scripts.md) and then run the `lure build` comand to build the local `lure.sh` file into a package for your distro (more info about the `build` command [here](./usage.md#build)). You can then install this file to your distro and test it. ## How to submit a package