Files
feed-prpl/README.md
Petr Štetiar 8d368d7202 README.md: fix outdated information
Sync information with current state.

Signed-off-by: Petr Štetiar
2022-02-05 11:00:59 +00:00

30 lines
1.6 KiB
Markdown

# OpenWrt/LEDE packages from prpl Foundation and its Members
Feed of OpenWrt/LEDE packages from prpl Foundation members
## How to add the prpl Feed to you OpenWrt/LEDE build
At the root of your OpenWrt/LEDE tree, add the following to your `feeds.conf` file:
```sh
src-git feed_prpl https://gitlab.com/prpl-foundation/prplOS/feed-prpl.git
```
Now to add the packages on your prpl feed to your OpenWrt/LEDE instance:
```sh
./scripts/feeds update feed_prpl #retrieve the prpl feed from service/update to latest
./scripts/feeds install -p feed_prpl #make all of the prpl feed packages available to the build
```
For more control over the package versions being installed, you can fork the feed using Gitlab (and replace the `src-git` url) or maintaining a copy of the feed on your local system by using this line instead:
```sh
src-link feed_prpl /full/path/to/feed-prpl/root
```
## How to add a package to the prpl Feed
1. Fork this repository
2. Add a directory for the package in the appropriate place (usually root) of your forked prpl Feed repo.
A few things to remember:
* Make sure to include all of the dependencies in your package's `Makefile`.
* Make sure to add your package to `CI_SDK_BUILD_PACKAGES` list in [.gitlab-ci.yml](https://gitlab.com/prpl-foundation/prplos/feed-prpl/-/blob/prplos/.gitlab-ci.yml) CI configuration.
* List the [SPDX license tag](https://spdx.org/licenses/) in your package's `Makefile` by setting the `PKG_LICENSE` using the `:=` operator.
3. Create a merge request to submit your package for consideration and review.
4. Your package is added to the feed.