max/nix-super
1
0
Fork 0
mirror of https://github.com/privatevoid-net/nix-super.git synced 2024-11-10 00:08:07 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
nix-super/README.md

39 lines
2 KiB
Markdown
Raw Normal View History

Revamp README.md
2020-04-30 23:01:28 +03:00
# Nix
Add Open Collective
2019-07-18 11:57:26 +03:00
[![Open Collective supporters](https://opencollective.com/nixos/tiers/supporter/badge.svg?label=Supporters&color=brightgreen)](https://opencollective.com/nixos)
README: add github actions badge
2020-04-09 16:04:51 +03:00
[![Test](https://github.com/NixOS/nix/workflows/Test/badge.svg)](https://github.com/NixOS/nix/actions)
Add Open Collective
2019-07-18 11:57:26 +03:00
Revamp README.md
2020-04-30 23:01:28 +03:00
Nix is a powerful package manager for Linux and other Unix systems that makes package
manual: Contributing -> Development, Hacking -> Building (#9014) * manual: Contributing -> Development, Hacking -> Building what's currently called "hacking" are really instructions for setting up a development environment and compiling from source. we have a contribution guide in the repo (which rightly focuses on GitHub workflows), and the material in the manual is more about working on the code itself. since we'd otherwise have three headings that amount to "Building Nix", this change also moves the "classic Nix" instructions to the top. we may want to reorganise this in the future, and bring contributor-oriented information closer to the code, but for now let's stick to more accurate names to ease navigation.
2024-07-25 05:53:06 +03:00
management reliable and reproducible. Please refer to the [Nix manual](https://nix.dev/reference/nix-manual)
Revamp README.md
2020-04-30 23:01:28 +03:00
for more details.
refer to nix.dev for installation instructions there are currently multiple places with installation instructions that all have to be updated when a change to any of them is accepted. this reduces the number of places by one, and directs beginners to the maintained and curated resource for Nix learning materials.
2023-09-21 03:53:11 +03:00
## Installation and first steps
Revamp README.md
2020-04-30 23:01:28 +03:00
more specific links to nix.dev
2023-10-05 10:20:42 +03:00
Visit [nix.dev](https://nix.dev) for [installation instructions](https://nix.dev/tutorials/install-nix) and [beginner tutorials](https://nix.dev/tutorials/first-steps).
Revamp README.md
2020-04-30 23:01:28 +03:00
manual: Contributing -> Development, Hacking -> Building (#9014) * manual: Contributing -> Development, Hacking -> Building what's currently called "hacking" are really instructions for setting up a development environment and compiling from source. we have a contribution guide in the repo (which rightly focuses on GitHub workflows), and the material in the manual is more about working on the code itself. since we'd otherwise have three headings that amount to "Building Nix", this change also moves the "classic Nix" instructions to the top. we may want to reorganise this in the future, and bring contributor-oriented information closer to the code, but for now let's stick to more accurate names to ease navigation.
2024-07-25 05:53:06 +03:00
Full reference documentation can be found in the [Nix manual](https://nix.dev/reference/nix-manual).
Revamp README.md
2020-04-30 23:01:28 +03:00
add more context on the README (#9871) the thesis is still the defining document with all the motivation and explanations. adding it here for greater visibility. also more emphasis and clarity around the community aspect. the hydra build job seems a bit arbitrary right there. may be better for the contributing guide.
2024-06-11 18:52:33 +03:00
## Building and developing
Revamp README.md
2020-04-30 23:01:28 +03:00
manual: Contributing -> Development, Hacking -> Building (#9014) * manual: Contributing -> Development, Hacking -> Building what's currently called "hacking" are really instructions for setting up a development environment and compiling from source. we have a contribution guide in the repo (which rightly focuses on GitHub workflows), and the material in the manual is more about working on the code itself. since we'd otherwise have three headings that amount to "Building Nix", this change also moves the "classic Nix" instructions to the top. we may want to reorganise this in the future, and bring contributor-oriented information closer to the code, but for now let's stick to more accurate names to ease navigation.
2024-07-25 05:53:06 +03:00
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).
convert README to markdown #825
2016-05-30 17:17:51 +03:00
README: link to CONTRIBUTING
2023-09-21 03:53:36 +03:00
## Contributing
Check the [contributing guide](./CONTRIBUTING.md) if you want to get involved with developing Nix.
add more context on the README (#9871) the thesis is still the defining document with all the motivation and explanations. adding it here for greater visibility. also more emphasis and clarity around the community aspect. the hydra build job seems a bit arbitrary right there. may be better for the contributing guide.
2024-06-11 18:52:33 +03:00
## Additional resources
Add link to hacking section of the manual (#973)
2016-07-21 00:17:55 +03:00
add more context on the README (#9871) the thesis is still the defining document with all the motivation and explanations. adding it here for greater visibility. also more emphasis and clarity around the community aspect. the hydra build job seems a bit arbitrary right there. may be better for the contributing guide.
2024-06-11 18:52:33 +03:00
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.
Today, a world-wide developer community contributes to Nix and the ecosystem that has grown around it.
- [The Nix, Nixpkgs, NixOS Community on nixos.org](https://nixos.org/)
- [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)
- [NixOS](https://github.com/NixOS/nixpkgs/tree/master/nixos) is a Linux distribution that can be configured fully declaratively
- [Discourse](https://discourse.nixos.org/)
- [Matrix](https://matrix.to/#/#nix:nixos.org)
Add link to hacking section of the manual (#973)
2016-07-21 00:17:55 +03:00
convert README to markdown #825
2016-05-30 17:17:51 +03:00
## License
Tweak README.md
2020-05-01 12:47:26 +03:00
Nix is released under the [LGPL v2.1](./COPYING).
Reference in a new issue Copy permalink