Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revamp README.md #3552

Merged
merged 4 commits into from May 1, 2020
Merged

Revamp README.md #3552

merged 4 commits into from May 1, 2020

Conversation

@gilligan
Copy link
Contributor

gilligan commented Apr 30, 2020

The current README looks a bit lackluster and almost exclusively relays to nixos.org/nix for all information. While I understand and accept that we should not duplicate a lot of information these changes introduce very manageable redundancy while still providing the info that is most relevant:

  • how do i install this?
  • how do i build this?
  • how do I develop this?
  • where can i find related information?

The https://github.com/tazjin/nix-1p article is the least official part of the external resources that I linked. If that is a concern i could just remove it again. If there are other suggestions for external resources i'm all ears!

README.md Outdated
- [Nix jobs on nixos.hydra.org](https://hydra.nixos.org/project/nix)
- [Nix - A One Pager](https://github.com/tazjin/nix-1p)
- [NixOS Discourse](https://discourse.nixos.org/)
- #nix / #nixos on irc.freenode.net

This comment has been minimized.

Copy link
@cole-h

cole-h Apr 30, 2020

Member

#nix: Cannot join channel (+i) - you must be invited

Is this correct?


If nobody has a problem with its presence in the first place, I, personally, would put the third-party nix-1p repo at the bottom, to somewhat separate it from the other official resources.

This comment has been minimized.

Copy link
@worldofpeace

worldofpeace May 1, 2020

Member

If nobody has a problem with its presence in the first place, I, personally, would put the third-party nix-1p repo at the bottom, to somewhat separate it from the other official resources.

If @edolstra "blesses" the document as useful maybe we can have it here. It's certainly helpful.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
domenkozar and others added 2 commits May 1, 2020
Co-authored-by: worldofpeace <worldofpeace@protonmail.ch>
Co-authored-by: worldofpeace <worldofpeace@protonmail.ch>
README.md Outdated Show resolved Hide resolved
@domenkozar domenkozar merged commit 93874cc into NixOS:master May 1, 2020
4 checks passed
4 checks passed
tests (ubuntu-18.04)
Details
tests (ubuntu-18.04)
Details
tests (macos)
Details
tests (macos)
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants
You can’t perform that action at this time.