Skip to content

docs: replace placeholder warning with quick-start usage guide#2292

Open
thevanshit wants to merge 1 commit into
ngi-nix:mainfrom
thevanshit:docs/readme-quickstart
Open

docs: replace placeholder warning with quick-start usage guide#2292
thevanshit wants to merge 1 commit into
ngi-nix:mainfrom
thevanshit:docs/readme-quickstart

Conversation

@thevanshit

Copy link
Copy Markdown

Replaces the 'end-user instructions not available yet' warning with concrete usage documentation.

Adds sections covering:

  • Quick start: Add NGIpkgs as a flake input
  • Using packages: nix run, nix build, configuration integration
  • Using NixOS modules: programs and services
  • Trying demos in a virtual machine
  • Using the NGIpkgs overlay

Also fixes minor typos in the Structure section.

Closes: #2256

Replaces the 'end-user instructions not available yet' warning with concrete usage documentation.

Adds sections covering:
- Quick start: Add NGIpkgs as a flake input
- Using packages: nix run, nix build, configuration integration
- Using NixOS modules: programs and services
- Trying demos in a virtual machine
- Using the NGIpkgs overlay

Also fixes minor typos in the Structure section.

Closes: ngi-nix#2256
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

Add clear documentation

1 participant