Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3552 from gilligan/revamp-readme
Revamp README.md
- Loading branch information
Showing
1 changed file
with
45 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,55 @@ | ||
# Nix | ||
|
||
[![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) | ||
|
||
Nix, the purely functional package manager | ||
------------------------------------------ | ||
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. | ||
|
||
## Installation | ||
|
||
On Linux and macOS the easiest way to Install Nix is to run the following shell command | ||
(as a user other than root): | ||
|
||
``` | ||
$ 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 | ||
|
||
### Building Nix | ||
|
||
You can build Nix via Nix via one of the targets provided by [release.nix](./release.nix): | ||
|
||
``` | ||
$ nix-build ./release.nix -A build.aarch64-linux | ||
$ nix-build ./release.nix -A build.x86_64-darwin | ||
$ nix-build ./release.nix -A build.i686-linux | ||
$ nix-build ./release.nix -A build.x86_64-linux | ||
``` | ||
|
||
### Development Environment | ||
|
||
Nix is a new take on package management that is fairly unique. Because of its | ||
purity aspects, a lot of issues found in traditional package managers don't | ||
appear with Nix. | ||
You can use the provided `shell.nix` to easily bootstrap a working development environment: | ||
|
||
To find out more about the tool, usage and installation instructions, please | ||
read the manual, which is available on the Nix website at | ||
<https://nixos.org/nix/manual>. | ||
``` | ||
$ nix-shell | ||
$ ./bootstrap.sh | ||
$ ./configure | ||
$ make | ||
``` | ||
|
||
## Contributing | ||
## Additional Resources | ||
|
||
Take a look at the [Hacking Section](https://nixos.org/nix/manual/#chap-hacking) | ||
of the manual. It helps you to get started with building Nix from source. | ||
- [Nix manual](https://nixos.org/nix/manual) | ||
- [Nix jobsets on hydra.nixos.org](https://hydra.nixos.org/project/nix) | ||
- [Nix - A One Pager](https://github.com/tazjin/nix-1p) | ||
- [NixOS Discourse](https://discourse.nixos.org/) | ||
- [IRC - #nixos on freenode.net](irc://irc.freenode.net/#nixos) | ||
|
||
## License | ||
|
||
Nix is released under the LGPL v2.1 | ||
Nix is released under the [LGPL v2.1](./COPYING) |