From f1d93acc2b8add71df9b9c771c44635533e01745 Mon Sep 17 00:00:00 2001 From: Jan Klass Date: Sat, 12 Jul 2025 19:11:15 +0200 Subject: [PATCH] Add doc section and links to home page Add links to the documentation sections, right after installation instructions, to guide users into them, and give them a short overview. The sections Design Notes and Advanced are not included here. They are not significant for new or unfamiliar users, and remain discoverable within the documentation book. Resolves #1952 --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 2cbc4b08c42..f3d95291bc3 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,14 @@ winget install nushell After installing, launch Nu by typing `nu`. +## Documentation + +* [Getting Started](/book/getting_started.html) guides you through getting familiar with Nushell +* [Coming to Nu](/book/coming_to_nu.html) describes similarities and differences to other languages and shells +* [Nu Fundamentals](/book/nu_fundamentals.html) is a more elaborate and structured description of the fundamentals +* [Programming in Nu](/book/programming_in_nu.html) describes Nu as a programming language +* [Nu as a Shell](/book/nu_as_a_shell.html) gives you insight into interactive functionality and configurability in a shell environment + ## Community Join us [on Discord](https://discord.gg/NtAbbGn) if you have any questions about Nu!