Merge pull request #270255 from NixOS/backport-265728-to-release-23.11
[NixPkgs.git] / README.md
blob7284d39a4c13ea95280af58ffeb328efeb004bdb
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>
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>
15 [Nixpkgs](https://github.com/nixos/nixpkgs) is a collection of over
16 80,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.
20 # Manuals
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
26 # Community
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.)
34 # Other Project Repositories
36 The sources of all official Nix-related projects are in the [NixOS
37 organization on GitHub](https://github.com/NixOS/). Here are some of
38 the main ones:
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
48 # Continuous Integration and Distribution
50 Nixpkgs and NixOS are built and tested by our continuous integration
51 system, [Hydra](https://hydra.nixos.org/).
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)
58 Artifacts successfully built with Hydra are published to cache at
59 https://cache.nixos.org/. When successful build and test criteria are
60 met, the Nixpkgs expressions are distributed via [Nix
61 channels](https://nixos.org/manual/nix/stable/package-management/channels.html).
63 # Contributing
65 Nixpkgs is among the most active projects on GitHub. While thousands
66 of open issues and pull requests might seem a lot at first, it helps
67 consider it in the context of the scope of the project. Nixpkgs
68 describes how to build tens of thousands of pieces of software and implements a
69 Linux distribution. The [GitHub Insights](https://github.com/NixOS/nixpkgs/pulse)
70 page gives a sense of the project activity.
72 Community contributions are always welcome through GitHub Issues and
73 Pull Requests.
75 For more information about contributing to the project, please visit
76 the [contributing page](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
78 # Donations
80 The infrastructure for NixOS and related projects is maintained by a
81 nonprofit organization, the [NixOS
82 Foundation](https://nixos.org/nixos/foundation.html). To ensure the
83 continuity and expansion of the NixOS infrastructure, we are looking
84 for donations to our organization.
86 You can donate to the NixOS foundation through [SEPA bank
87 transfers](https://nixos.org/donate.html) or by using Open Collective:
89 <a href="https://opencollective.com/nixos#support"><img src="https://opencollective.com/nixos/tiers/supporter.svg?width=890" /></a>
91 # License
93 Nixpkgs is licensed under the [MIT License](COPYING).
95 Note: MIT license does not apply to the packages built by Nixpkgs,
96 merely to the files in this repository (the Nix expressions, build
97 scripts, NixOS modules, etc.). It also might not apply to patches
98 included in Nixpkgs, which may be derivative works of the packages to
99 which they apply. The aforementioned artifacts are all covered by the
100 licenses of the respective packages.