aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDomen Kožar <domen@dev.si>2020-05-01 11:23:08 +0200
committerGitHub <noreply@github.com>2020-05-01 11:23:08 +0200
commit93874cc18a4095d60faaaa00e3624474c1856398 (patch)
tree20f8419f7702e65ebdd9f883e9e97787250d14dc /README.md
parent625868b33dab37c0750081843be8091e22808376 (diff)
parent2a434fc62bdb4391620d8030aec6b8d4a9f8ba95 (diff)
Merge pull request #3552 from gilligan/revamp-readme
Revamp README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md57
1 files changed, 45 insertions, 12 deletions
diff --git a/README.md b/README.md
index 9c0c87887..44687a150 100644
--- a/README.md
+++ b/README.md
@@ -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)