README.md

   1 <p align="center">
   2   <a href="https://nixos.org/nixos"><img src="https://nixos.org/logo/nixos-hires.png" width="500px" alt="NixOS logo" /></a>
   3 </p>
   4
   5 <p align="center">
   6   <a href="https://www.codetriage.com/nixos/nixpkgs"><img src="https://www.codetriage.com/nixos/nixpkgs/badges/users.svg" alt="Code Triagers badge" /></a>
   7   <a href="https://opencollective.com/nixos"><img src="https://opencollective.com/nixos/tiers/supporter/badge.svg?label=Supporter&color=brightgreen" alt="Open Collective supporters" /></a>
   8 </p>
   9
  10 [Nixpkgs](https://github.com/nixos/nixpkgs) is a collection of over
  11 60,000 software packages that can be installed with the
  12 [Nix](https://nixos.org/nix/) package manager. It also implements
  13 [NixOS](https://nixos.org/nixos/), a purely-functional Linux distribution.
  14
  15 # Manuals
  16
  17 * [NixOS Manual](https://nixos.org/nixos/manual) - how to install, configure, and maintain a purely-functional Linux distribution
  18 * [Nixpkgs Manual](https://nixos.org/nixpkgs/manual/) - contributing to Nixpkgs and using programming-language-specific Nix expressions
  19 * [Nix Package Manager Manual](https://nixos.org/nix/manual) - how to write Nix expressions (programs), and how to use Nix command line tools
  20
  21 # Community
  22
  23 * [Discourse Forum](https://discourse.nixos.org/)
  24 * [IRC - #nixos on freenode.net](irc://irc.freenode.net/#nixos)
  25 * [NixOS Weekly](https://weekly.nixos.org/)
  26 * [Community-maintained wiki](https://nixos.wiki/)
  27 * [Community-maintained list of ways to get in touch](https://nixos.wiki/wiki/Get_In_Touch#Chat) (Discord, Matrix, Telegram, other IRC channels, etc.)
  28
  29 # Other Project Repositories
  30
  31 The sources of all official Nix-related projects are in the [NixOS
  32 organization on GitHub](https://github.com/NixOS/). Here are some of
  33 the main ones:
  34
  35 * [Nix](https://github.com/NixOS/nix) - the purely functional package manager
  36 * [NixOps](https://github.com/NixOS/nixops) - the tool to remotely deploy NixOS machines
  37 * [nixos-hardware](https://github.com/NixOS/nixos-hardware) - NixOS profiles to optimize settings for different hardware
  38 * [Nix RFCs](https://github.com/NixOS/rfcs) - the formal process for making substantial changes to the community
  39 * [NixOS homepage](https://github.com/NixOS/nixos-homepage) - the [NixOS.org](https://nixos.org) website
  40 * [hydra](https://github.com/NixOS/hydra) - our continuous integration system
  41 * [NixOS Artwork](https://github.com/NixOS/nixos-artwork) - NixOS artwork
  42
  43 # Continuous Integration and Distribution
  44
  45 Nixpkgs and NixOS are built and tested by our continuous integration
  46 system, [Hydra](https://hydra.nixos.org/).
  47
  48 * [Continuous package builds for unstable/master](https://hydra.nixos.org/jobset/nixos/trunk-combined)
  49 * [Continuous package builds for the NixOS 20.09 release](https://hydra.nixos.org/jobset/nixos/release-20.09)
  50 * [Tests for unstable/master](https://hydra.nixos.org/job/nixos/trunk-combined/tested#tabs-constituents)
  51 * [Tests for the NixOS 20.09 release](https://hydra.nixos.org/job/nixos/release-20.09/tested#tabs-constituents)
  52
  53 Artifacts successfully built with Hydra are published to cache at
  54 https://cache.nixos.org/. When successful build and test criteria are
  55 met, the Nixpkgs expressions are distributed via [Nix
  56 channels](https://nixos.org/nix/manual/#sec-channels).
  57
  58 # Contributing
  59
  60 Nixpkgs is among the most active projects on GitHub. While thousands
  61 of open issues and pull requests might seem a lot at first, it helps
  62 consider it in the context of the scope of the project. Nixpkgs
  63 describes how to build tens of thousands of pieces of software and implements a
  64 Linux distribution. The [GitHub Insights](https://github.com/NixOS/nixpkgs/pulse)
  65 page gives a sense of the project activity.
  66
  67 Community contributions are always welcome through GitHub Issues and
  68 Pull Requests. When pull requests are made, our tooling automation bot,
  69 [OfBorg](https://github.com/NixOS/ofborg) will perform various checks
  70 to help ensure expression quality.
  71
  72 The *Nixpkgs maintainers* are people who have assigned themselves to
  73 maintain specific individual packages. We encourage people who care
  74 about a package to assign themselves as a maintainer. When a pull
  75 request is made against a package, OfBorg will notify the appropriate
  76 maintainer(s). The *Nixpkgs committers* are people who have been given
  77 permission to merge.
  78
  79 Most contributions are based on and merged into these branches:
  80
  81 * `master` is the main branch where all small contributions go
  82 * `staging` is branched from master, changes that have a big impact on
  83   Hydra builds go to this branch
  84 * `staging-next` is branched from staging and only fixes to stabilize
  85   and security fixes with a big impact on Hydra builds should be
  86   contributed to this branch. This branch is merged into master when
  87   deemed of sufficiently high quality
  88
  89 For more information about contributing to the project, please visit
  90 the [contributing page](https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md).
  91
  92 # Donations
  93
  94 The infrastructure for NixOS and related projects is maintained by a
  95 nonprofit organization, the [NixOS
  96 Foundation](https://nixos.org/nixos/foundation.html). To ensure the
  97 continuity and expansion of the NixOS infrastructure, we are looking
  98 for donations to our organization.
  99
 100 You can donate to the NixOS foundation by using Open Collective:
 101
 102 <a href="https://opencollective.com/nixos#support"><img src="https://opencollective.com/nixos/tiers/supporter.svg?width=890" /></a>
 103
 104 # License
 105
 106 Nixpkgs is licensed under the [MIT License](COPYING).
 107
 108 Note: MIT license does not apply to the packages built by Nixpkgs,
 109 merely to the files in this repository (the Nix expressions, build
 110 scripts, NixOS modules, etc.). It also might not apply to patches
 111 included in Nixpkgs, which may be derivative works of the packages to
 112 which they apply. The aforementioned artifacts are all covered by the
 113 licenses of the respective packages.