diff options
| author | Michael Hoang <enzime@users.noreply.github.com> | 2024-11-17 12:46:35 +1100 |
|---|---|---|
| committer | Michael Hoang <enzime@users.noreply.github.com> | 2024-11-21 11:07:47 +1100 |
| commit | 3c27b0874017b325b0ed7269705c0d2df5df42dc (patch) | |
| tree | 70dcbb0ceeb5faa20c320519cb16b25c58e74b1d /README.md | |
| parent | 60ed03d0b10fa88054a73a0d34338f03f8d73f53 (diff) | |
readme: update `Documentation` section
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 26 |
1 files changed, 2 insertions, 24 deletions
@@ -153,31 +153,9 @@ nix-channel --update darwin ## Documentation -Reference documentation of all the options is available [here](https://daiderd.com/nix-darwin/manual/index.html). -This can also be accessed locally using `man 5 configuration.nix`. +`darwin-help` will open up a local copy of the reference documentation, it can also be found online [here](https://daiderd.com/nix-darwin/manual/index.html). -`darwin-help` will open a HTML version of the manpage in the default browser. - -Furthermore there's `darwin-option` to introspect the settings of a system and its available options. -> NOTE: `darwin-option` is only available to non-flake installations. - -``` -$ darwin-option nix.linux-builder.enable -Value: -true - -Default: -false - -Example: -true - -Description: -Whether to enable Linux builder. -``` - -There's also a small wiki https://github.com/LnL7/nix-darwin/wiki about -specific topics, like macOS upgrades. +The documentation is also available as manpages by running `man 5 configuration.nix`. ## Uninstalling |
