custom README

This commit is contained in:
Max Headroom 2022-02-21 23:14:30 +01:00
parent d8995c2f68
commit 37edecb169

View file

@ -1,36 +1,11 @@
# Nix
# Nix Super
[![Open Collective supporters](https://opencollective.com/nixos/tiers/supporter/badge.svg?label=Supporters&color=brightgreen)](https://opencollective.com/nixos)
[![Test](https://github.com/NixOS/nix/workflows/Test/badge.svg)](https://github.com/NixOS/nix/actions)
## It's [Nix](https://nixos.org), but super!
Nix is a powerful package manager for Linux and other Unix systems that makes package
management reliable and reproducible. Please refer to the [Nix manual](https://nixos.org/nix/manual)
for more details.
This is an upstream-tracking fork of Nix that includes various patches, some controversial in nature and not fit for Nix upstream.
## Installation
On Linux and macOS the easiest way to install Nix is to run the following shell command
(as a user other than root):
```console
$ curl -L https://nixos.org/nix/install | sh
```
Information on additional installation methods is available on the [Nix download page](https://nixos.org/download.html).
## Building And Developing
See our [Hacking guide](https://hydra.nixos.org/job/nix/master/build.x86_64-linux/latest/download-by-type/doc/manual/contributing/hacking.html) in our manual for instruction on how to
build nix from source with nix-build or how to get a development environment.
## Additional Resources
- [Nix manual](https://nixos.org/nix/manual)
- [Nix jobsets on hydra.nixos.org](https://hydra.nixos.org/project/nix)
- [NixOS Discourse](https://discourse.nixos.org/)
- [Matrix - #nix:nixos.org](https://matrix.to/#/#nix:nixos.org)
- [IRC - #nixos on libera.chat](irc://irc.libera.chat/#nixos)
## License
Nix is released under the [LGPL v2.1](./COPYING).
Some of the patches included are:
- nix-flake-default from [nix-dram](https://github.com/dramforever/nix-dram)
- enable-all-experimental from the old [nixExperimental](https://github.com/NixOS/nixpkgs/pull/120141)
- Full thunk evaluation in flake inputs
- Some UI improvements