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