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

README: revise README, appearance and content #138

Merged
merged 6 commits into from May 5, 2020

Conversation

@samueldr
Copy link
Member

samueldr commented May 4, 2020

I feel this should have been done the moment documentation was added, and the project was adopted into the NixOS org.

The README:

  • now refers to the documentation, rather than keep instructions that may change
  • includes the same kind of content as the main Nixpkgs README
  • looks more like the main Nixpkgs README

The main goal is to deduplicate instructions. I don't want to maintain that 2-minutes startup guide, especially considering it's assuming way too much. The getting started section is what it should have been.

By doing so, we now gained an about page, which can be furnished a bit more later, with e.g. #69.

Fixes #73.

@samueldr samueldr force-pushed the samueldr-wip:docs/readme branch from 2a0cb65 to a27fc71 May 5, 2020
@samueldr samueldr merged commit 6be1a3b into NixOS:master May 5, 2020
@samueldr samueldr deleted the samueldr-wip:docs/readme branch May 5, 2020
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.

1 participant
You can’t perform that action at this time.