mirror of
https://github.com/NixOS/nix.git
synced 2025-11-11 21:16:02 +01:00
Merge pull request #84 from DeterminateSystems/lucperkins/gtm-51-update-nix-src-readme-to-better-reflect-what-the-project-is
Rework README
This commit is contained in:
commit
02c3c64bd4
1 changed files with 77 additions and 23 deletions
100
README.md
100
README.md
|
|
@ -1,38 +1,92 @@
|
||||||
# Nix
|
<p align="center">
|
||||||
|
<a href="https://determinate.systems" target="_blank"><img src="https://raw.githubusercontent.com/determinatesystems/.github/main/.github/banner.jpg"></a>
|
||||||
|
</p>
|
||||||
|
<p align="center">
|
||||||
|
<a href="https://determinate.systems/discord" target="_blank"><img alt="Discord" src="https://img.shields.io/discord/1116012109709463613?style=for-the-badge&logo=discord&logoColor=%23ffffff&label=Discord&labelColor=%234253e8&color=%23e4e2e2"></a>
|
||||||
|
<a href="https://bsky.app/profile/determinate.systems" target="_blank"><img alt="Bluesky" src="https://img.shields.io/badge/Bluesky-0772D8?style=for-the-badge&logo=bluesky&logoColor=%23ffffff"></a>
|
||||||
|
<a href="https://hachyderm.io/@determinatesystems" target="_blank"><img alt="Mastodon" src="https://img.shields.io/badge/Mastodon-6468fa?style=for-the-badge&logo=mastodon&logoColor=%23ffffff"></a>
|
||||||
|
<a href="https://twitter.com/DeterminateSys" target="_blank"><img alt="Twitter" src="https://img.shields.io/badge/Twitter-303030?style=for-the-badge&logo=x&logoColor=%23ffffff"></a>
|
||||||
|
<a href="https://www.linkedin.com/company/determinate-systems" target="_blank"><img alt="LinkedIn" src="https://img.shields.io/badge/LinkedIn-1667be?style=for-the-badge&logo=linkedin&logoColor=%23ffffff"></a>
|
||||||
|
</p>
|
||||||
|
|
||||||
[](https://opencollective.com/nixos)
|
# Determinate Nix
|
||||||
[](https://github.com/NixOS/nix/actions/workflows/ci.yml)
|
|
||||||
|
|
||||||
Nix is a powerful package manager for Linux and other Unix systems that makes package
|
[](https://github.com/DeterminateSystems/nix-src/actions/workflows/ci.yml)
|
||||||
management reliable and reproducible. Please refer to the [Nix manual](https://nix.dev/reference/nix-manual)
|
|
||||||
for more details.
|
|
||||||
|
|
||||||
## Installation and first steps
|
This repository houses the source for [**Determinate Nix**][det-nix], a downstream distribution of [Nix][upstream] created and maintained by [Determinate Systems][detsys].
|
||||||
|
Nix is a powerful [language], [package manager][package-management], and [CLI] for [macOS](#macos), [Linux](linux), and other Unix systems that enables you to create fully reproducible [development environments][envs], to build [packages] in sandboxed environments, to build entire Linux systems using [NixOS], and much more.
|
||||||
|
|
||||||
Visit [nix.dev](https://nix.dev) for [installation instructions](https://nix.dev/tutorials/install-nix) and [beginner tutorials](https://nix.dev/tutorials/first-steps).
|
Determinate Nix is part of the [Determinate platform][determinate], which also includes [FlakeHub], a secure flake repository with features like [FlakeHub Cache][cache], [private flakes][private-flakes], and [semantic versioning][semver] (SemVer) for [flakes].
|
||||||
|
|
||||||
Full reference documentation can be found in the [Nix manual](https://nix.dev/reference/nix-manual).
|
## Installing Determinate
|
||||||
|
|
||||||
## Building and developing
|
You can install Determinate on [macOS](#macos), non-NixOS [Linux](#linux) and WSL, and [NixOS](#nixos).
|
||||||
|
|
||||||
Follow instructions in the Nix reference manual to [set up a development environment and build Nix from source](https://nix.dev/manual/nix/development/development/building.html).
|
### macOS
|
||||||
|
|
||||||
## Contributing
|
On macOS, we recommend using the graphical installer from Determinate Systems.
|
||||||
|
Click [here][gui] to download and run it.
|
||||||
|
|
||||||
Check the [contributing guide](./CONTRIBUTING.md) if you want to get involved with developing Nix.
|
### Linux
|
||||||
|
|
||||||
## Additional resources
|
On Linux, including Windows Subsystem for Linux (WSL), we recommend installing Determinate Nix using [Determinate Nix Installer][installer]:
|
||||||
|
|
||||||
Nix was created by Eelco Dolstra and developed as the subject of his PhD thesis [The Purely Functional Software Deployment Model](https://edolstra.github.io/pubs/phd-thesis.pdf), published 2006.
|
```shell
|
||||||
Today, a world-wide developer community contributes to Nix and the ecosystem that has grown around it.
|
curl -fsSL https://install.determinate.systems/nix | sh -s -- install --determinate
|
||||||
|
```
|
||||||
|
|
||||||
- [The Nix, Nixpkgs, NixOS Community on nixos.org](https://nixos.org/)
|
### NixOS
|
||||||
- [Official documentation on nix.dev](https://nix.dev)
|
|
||||||
- [Nixpkgs](https://github.com/NixOS/nixpkgs) is [the largest, most up-to-date free software repository in the world](https://repology.org/repositories/graphs)
|
On [NixOS], we recommend following our [dedicated installation guide][nixos-install].
|
||||||
- [NixOS](https://github.com/NixOS/nixpkgs/tree/master/nixos) is a Linux distribution that can be configured fully declaratively
|
|
||||||
- [Discourse](https://discourse.nixos.org/)
|
## Other resources
|
||||||
- Matrix: [#users:nixos.org](https://matrix.to/#/#users:nixos.org) for user support and [#nix-dev:nixos.org](https://matrix.to/#/#nix-dev:nixos.org) for development
|
|
||||||
|
Nix was created by [Eelco Dolstra][eelco] and developed as the subject of his 2006 PhD thesis, [The Purely Functional Software Deployment Model][thesis].
|
||||||
|
Today, a worldwide developer community contributes to Nix and the ecosystem that has grown around it.
|
||||||
|
|
||||||
|
- [Zero to Nix][z2n], Determinate Systems' guide to Nix and [flakes] for beginners
|
||||||
|
- [Nixpkgs], a collection of well over 100,000 software packages that you can build and manage using Nix
|
||||||
|
- [NixOS] is a Linux distribution that can be configured fully declaratively
|
||||||
|
- The Nix, Nixpkgs, and NixOS community on [nixos.org][website]
|
||||||
|
|
||||||
|
## Reference
|
||||||
|
|
||||||
|
The primary documentation for Determinate and Determinate Nix is available at [docs.determinate.systems][determinate].
|
||||||
|
For deeply technical reference material, see the [Determinate Nix manual][manual] which is based on the upstream Nix manual.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Nix is released under the [LGPL v2.1](./COPYING).
|
[Upstream Nix][upstream] is released under the [LGPL v2.1][license] license.
|
||||||
|
[Determinate Nix][det-nix] is also released under LGPL v2.1 in accordance with the terms of the upstream license.
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
Check the [contributing guide][contributing] if you want to get involved with developing Nix.
|
||||||
|
|
||||||
|
[cache]: https://docs.determinate.systems/flakehub/cache
|
||||||
|
[cli]: https://manual.determinate.systems/command-ref/new-cli/nix.html
|
||||||
|
[contributing]: ./CONTRIBUTING.md
|
||||||
|
[det-nix]: https://docs.determinate.systems/determinate-nix
|
||||||
|
[determinate]: https://docs.determinate.systems
|
||||||
|
[detsys]: https://determinate.systems
|
||||||
|
[dnixd]: https://docs.determinate.systems/determinate-nix#determinate-nixd
|
||||||
|
[eelco]: https://determinate.systems/people/eelco-dolstra
|
||||||
|
[envs]: https://zero-to-nix.com/concepts/dev-env
|
||||||
|
[flakehub]: https://flakehub.com
|
||||||
|
[flakes]: https://zero-to-nix.com/concepts/flakes
|
||||||
|
[gui]: https://install.determinate.systems/determinate-pkg/stable/Universal
|
||||||
|
[installer]: https://github.com/DeterminateSystems/nix-installer
|
||||||
|
[language]: https://zero-to-nix.com/concepts/nix-language
|
||||||
|
[license]: ./COPYING
|
||||||
|
[manual]: https://manual.determinate.systems
|
||||||
|
[nixpkgs]: https://github.com/NixOS/nixpkgs
|
||||||
|
[nixos]: https://github.com/NixOS/nixpkgs/tree/master/nixos
|
||||||
|
[nixos-install]: https://docs.determinate.systems/guides/advanced-installation#nixos
|
||||||
|
[packages]: https://zero-to-nix.com/concepts/packages
|
||||||
|
[package-management]: https://zero-to-nix.com/concepts/package-management
|
||||||
|
[private-flakes]: https://docs.determinate.systems/flakehub/private-flakes
|
||||||
|
[semver]: https://docs.determinate.systems/flakehub/concepts/semver
|
||||||
|
[thesis]: https://edolstra.github.io/pubs/phd-thesis.pdf
|
||||||
|
[upstream]: https://github.com/NixOS/nix
|
||||||
|
[website]: https://nixos.org
|
||||||
|
[z2n]: https://zero-to-nix.com
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue