python312Packages.nanobind: disable checks on x86_64-darwin (#355084)
[NixPkgs.git] / README.md
blob8b16318bfc6857f7422962551ce9bd3d7f3db4e5
1 <p align="center">
2   <a href="https://nixos.org">
3     <picture>
4       <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/NixOS/nixos-homepage/main/public/logo/nixos-hires.png">
5       <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/NixOS/nixos-artwork/master/logo/nixos-white.png">
6       <img src="https://raw.githubusercontent.com/NixOS/nixos-homepage/main/public/logo/nixos-hires.png" width="500px" alt="NixOS logo">
7     </picture>
8   </a>
9 </p>
11 <p align="center">
12   <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>
13   <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>
14 </p>
16 [Nixpkgs](https://github.com/nixos/nixpkgs) is a collection of over
17 100,000 software packages that can be installed with the
18 [Nix](https://nixos.org/nix/) package manager. It also implements
19 [NixOS](https://nixos.org/nixos/), a purely-functional Linux distribution.
21 # Manuals
23 * [NixOS Manual](https://nixos.org/nixos/manual) - how to install, configure, and maintain a purely-functional Linux distribution
24 * [Nixpkgs Manual](https://nixos.org/nixpkgs/manual/) - contributing to Nixpkgs and using programming-language-specific Nix expressions
25 * [Nix Package Manager Manual](https://nixos.org/nix/manual) - how to write Nix expressions (programs), and how to use Nix command line tools
27 # Community
29 * [Discourse Forum](https://discourse.nixos.org/)
30 * [Matrix Chat](https://matrix.to/#/#community:nixos.org)
31 * [NixOS Weekly](https://weekly.nixos.org/)
32 * [Official wiki](https://wiki.nixos.org/)
33 * [Community-maintained list of ways to get in touch](https://wiki.nixos.org/wiki/Get_In_Touch#Chat) (Discord, Telegram, IRC, etc.)
35 # Other Project Repositories
37 The sources of all official Nix-related projects are in the [NixOS
38 organization on GitHub](https://github.com/NixOS/). Here are some of
39 the main ones:
41 * [Nix](https://github.com/NixOS/nix) - the purely functional package manager
42 * [NixOps](https://github.com/NixOS/nixops) - the tool to remotely deploy NixOS machines
43 * [nixos-hardware](https://github.com/NixOS/nixos-hardware) - NixOS profiles to optimize settings for different hardware
44 * [Nix RFCs](https://github.com/NixOS/rfcs) - the formal process for making substantial changes to the community
45 * [NixOS homepage](https://github.com/NixOS/nixos-homepage) - the [NixOS.org](https://nixos.org) website
46 * [hydra](https://github.com/NixOS/hydra) - our continuous integration system
47 * [NixOS Artwork](https://github.com/NixOS/nixos-artwork) - NixOS artwork
49 # Continuous Integration and Distribution
51 Nixpkgs and NixOS are built and tested by our continuous integration
52 system, [Hydra](https://hydra.nixos.org/).
54 * [Continuous package builds for unstable/master](https://hydra.nixos.org/jobset/nixos/trunk-combined)
55 * [Continuous package builds for the NixOS 24.05 release](https://hydra.nixos.org/jobset/nixos/release-24.05)
56 * [Tests for unstable/master](https://hydra.nixos.org/job/nixos/trunk-combined/tested#tabs-constituents)
57 * [Tests for the NixOS 24.05 release](https://hydra.nixos.org/job/nixos/release-24.05/tested#tabs-constituents)
59 Artifacts successfully built with Hydra are published to cache at
60 https://cache.nixos.org/. When successful build and test criteria are
61 met, the Nixpkgs expressions are distributed via [Nix
62 channels](https://nixos.org/manual/nix/stable/package-management/channels.html).
64 # Contributing
66 Nixpkgs is among the most active projects on GitHub. While thousands
67 of open issues and pull requests might seem a lot at first, it helps
68 consider it in the context of the scope of the project. Nixpkgs
69 describes how to build tens of thousands of pieces of software and implements a
70 Linux distribution. The [GitHub Insights](https://github.com/NixOS/nixpkgs/pulse)
71 page gives a sense of the project activity.
73 Community contributions are always welcome through GitHub Issues and
74 Pull Requests.
76 For more information about contributing to the project, please visit
77 the [contributing page](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
79 # Donations
81 The infrastructure for NixOS and related projects is maintained by a
82 nonprofit organization, the [NixOS
83 Foundation](https://nixos.org/nixos/foundation.html). To ensure the
84 continuity and expansion of the NixOS infrastructure, we are looking
85 for donations to our organization.
87 You can donate to the NixOS foundation through [SEPA bank
88 transfers](https://nixos.org/donate.html) or by using Open Collective:
90 <a href="https://opencollective.com/nixos#support"><img src="https://opencollective.com/nixos/tiers/supporter.svg?width=890" /></a>
92 # License
94 Nixpkgs is licensed under the [MIT License](COPYING).
96 Note: MIT license does not apply to the packages built by Nixpkgs,
97 merely to the files in this repository (the Nix expressions, build
98 scripts, NixOS modules, etc.). It also might not apply to patches
99 included in Nixpkgs, which may be derivative works of the packages to
100 which they apply. The aforementioned artifacts are all covered by the
101 licenses of the respective packages.