Skip to content
This repository has been archived by the owner on Feb 27, 2024. It is now read-only.

Commit

Permalink
reword high-level goals
Browse files Browse the repository at this point in the history
put more emphasis on book scope and contents
  • Loading branch information
fricklerhandwerk committed May 19, 2022
1 parent 04f3b14 commit e6ba984
Showing 1 changed file with 9 additions and 13 deletions.
22 changes: 9 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,17 @@
# The Nix Book

## tl;dr
This community online learning resource — not a book in the conventional sense — is under development.

### Goals
It shall offer a centralized autodidactic onboarding path into Nix and its surrounding ecosystem.

- Improve the autodidactic Nix onboarding experience to increase community growth
- Provide a clear learning path from first impression down to source code
By explaing how each component works, how to make best use of it, and how to continue from there, it is supposed to fit between first impressions on the [Nix web site][nixos-org] and the reference manuals for [Nix][nix-manual], [Nixpkgs][nixpkgs-manual], [NixOS][nixos-manual].

### Tasks
[nixos-org]: https://nixos.org
[nix-manual]: https://nixos.org/manual/nix/stable/
[nixpkgs-manual]: https://nixos.org/manual/nixpkgs/stable/
[nixos-manual]: https://nixos.org/manual/nixos/stable/

- Write a book *actually explaining* Nix and its surrounding ecosystem at a high level of abstraction
- Overhaul the Nix manual to make it a focused technical reference
- Integrate new material into the Nix(OS) homepage

# Problem Statement

## Nix is hard to get into
# Motivation

Nix has a proverbially steep learning curve.

Expand Down Expand Up @@ -389,7 +385,7 @@ The results of sorting through and reorganizing material for the book can be mad
- through the lens of [Backward design](https://en.wikipedia.org/wiki/Backward_design)
- what are learning objectives and which material achieves which?
- add brief summaries to better orient readers
- rework navigation of learning on [nixos.org](http://nixos.org) to incorporate the new structure
- rework navigation of learning on [nixos.org][nixos-org] to incorporate the new structure
- lead readers and contributors to the right places for their types of questions

## How is success defined and measured?
Expand Down

0 comments on commit e6ba984

Please sign in to comment.