Giter VIP home page Giter VIP logo

opkg-repo's Introduction

FPV.WTF OPKG Repository

Custom OPKG repository for the FPV.WTF project.

This is the official reposiotry from which the WTFOS configurator pulls its packages.

Usage

Add the following entry to your opkg.conf:

src/gz fpv.wtf http://repo.fpv.wtf/pigeon

Update opkg and list packages from repository:

opkg update

Contribute

Your contributions are very welcome, there are a lot of ways to contribute to this project:

Submitting a Pull Request

Your bugfixes and improvements are always welcome. If you are unsure about a new feature, feel free to open an issue for discussion.

When submitting your PR, please submit it against the develop branch of this repository.

Adding your package

Fork the repository and add your Github project to repositories.json, then submit a PR. The package index will be rebuilt and your packages will be automatically added once your PR has been merged into master.

Each entry consists of two fields:

{
  "repo": "user/repo-name",
  "names": [
    "name_1",
    "name_2",
  ]
}
  • repo: Github repository name
  • names: An array of package names. This name is the first part of the actual filename of your ipk package but has also to match the Package field in your control file.

Example: If your package is called foobar, then the ipk in your release should be called foobar_$VERSION_$ARCH.ipk and the names array should only contain one entry: foobar.

Once the deployment runs it will check the latest release of your project, fetch all matching ipk files and check the control file:

  1. fetch name_1*.ipk and name_2*.ipk
  2. Check if the Package field matches in each of the ipk's

If everything checks out a new index is build. Otherwise the build fails and the offending package will be visible in the build logs.

Package naming

We ask that you give your packages a short, simple and descriptive name. Some examples include:

  • live-audio - for live audio on the v1 goggles and an au
  • auto-record - for automatically starting recording when air side is connected
  • avin-mods - for a package containing mulitple avin related tweaks

Please do not tag packages with the wtfos- prefix without consulting with the team first, as it's reserved for core packages. Please also don't tag packages with the author/group name, use the Maintainer .ipk control field instead. This will be shown soon in the configurator (as of time of writing).

Licensing

Please make sure that the package you are submitting has an open source license attached to it (preferably GPL V3). Pull Requests for packages without a license (or a too restrictive licence) will be rejected.

You can - at any point - run your own repository though (this code is GPL V3) if you are not happy with the licencing term. If you decide to do so make sure that you have some way of supporting your users, since there will be no official support for third party repositories.

Available architectures

To limit the systems on which your package can be installed, add one of the architectures (from general to specific):

  • pigeon-all
  • pigeon-glasses (v1 & v2)
  • pigeon-glasses-v1 or pigeon-glasses-v2
  • pigeon-airside (OG and Lite)
  • pigeon-airside-au or pigeon-airside-lite

IPK template

You can check out the IPK example repository. It provides a template in regards to folder structure, a Makefile and a workflow to automatically build IPK packages via Github Actions.

opkg-repo's People

Contributors

bri3d avatar d3vl-jack avatar funneld avatar j005u avatar loudnl avatar shambler123 avatar stylesuxx avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.