This commit is contained in:
Tom Bereknyei 2022-02-04 08:48:18 -05:00
parent 1ec758bb4d
commit 2b1da3a1a5
2 changed files with 70 additions and 0 deletions

20
COPYING Normal file
View File

@ -0,0 +1,20 @@
Copyright (c) 2022 Nixpkgs/NixOS contributors
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

50
README.md Normal file
View File

@ -0,0 +1,50 @@
# Nix Bundlers
Bundlers are a way to transform derivations. The most common and default usage is based on the [original by matthewbauer](https://github.com/matthewbauer/nix-bundle). Each bundler is function over a value (usually a derivation) that produces another derivation.
```
```console
$ nix bundle --bundler github:NixOS/bundlers nixpkgs#hello
```
# How to contribute
Main purpose of this repository is to collect most common bundlers to *make
common use-cases easy*. For this purpose the collection of bundlers is limited
to provided an opinionated and curated list.
TODO: bundlers should be also discoverable on search.nixos.org
## Opening issues
* Make sure you have a [GitHub account](https://github.com/signup/free)
* Make sure there is no open issue on the topic
* [Submit a new issue](https://github.com/NixOS/templates/issues/new)
## What is required to submit a bundler?
Note: This section is a WIP
Each bundler needs:
- `name`
Folder with the same name should be created and this is a location of the
bundler. An entry with `name` is requred in `flake.nix`.
- `description`
A description that explains the content of the bundler in one sentence. An
entry with `description` is requred in `flake.nix`.
- `maintainers`
Each bundler needs one of more maintainers with the knowledge of specific
area. Each bundler has an entry in `.github/CODEOWNERS` with maintainers
next to them.
# License
Note: contributing implies licensing those contributions
under the terms of [COPYING](COPYING), which is the MIT license.