forked from pub-solar/os
Merge remote-tracking branch 'origin/devos' into core
This commit is contained in:
commit
b3bbfcdab4
|
@ -10,12 +10,6 @@ rendered on every change, so the docs should always be up to date.
|
||||||
We also use [BORS](https://bors.tech) to ensure that all pull requests pass the
|
We also use [BORS](https://bors.tech) to ensure that all pull requests pass the
|
||||||
test suite once at least one review is completed.
|
test suite once at least one review is completed.
|
||||||
|
|
||||||
## Community PRs
|
|
||||||
While much of your work in this template may be idiosyncratic in nature. Anything
|
|
||||||
that might be generally useful to the broader NixOS community can be synced to
|
|
||||||
the `community` branch to provide a host of useful NixOS configurations available
|
|
||||||
"out of the box".
|
|
||||||
|
|
||||||
# Style
|
# Style
|
||||||
If you wish to contribute please follow these guidelines:
|
If you wish to contribute please follow these guidelines:
|
||||||
|
|
||||||
|
|
|
@ -5,9 +5,6 @@ Profiles are a convenient shorthand for the [_definition_][definition] of
|
||||||
built into the NixOS module system for a reason: to elegantly provide a clear
|
built into the NixOS module system for a reason: to elegantly provide a clear
|
||||||
separation of concerns.
|
separation of concerns.
|
||||||
|
|
||||||
If you need guidance, a community [branch](https://github.com/divnix/devos/tree/community/profiles)
|
|
||||||
is maintained to help get up to speed on their usage.
|
|
||||||
|
|
||||||
## Creation
|
## Creation
|
||||||
Profiles are created with the `rakeLeaves` function which recursively collects
|
Profiles are created with the `rakeLeaves` function which recursively collects
|
||||||
`.nix` files from within a folder. The recursion stops at folders with a `default.nix`
|
`.nix` files from within a folder. The recursion stops at folders with a `default.nix`
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# Suites
|
# Suites
|
||||||
Suites provide a mechanism for users to easily combine and name collecitons of
|
Suites provide a mechanism for users to easily combine and name collecitons of
|
||||||
profiles. For good examples, check out the suites defined in the community branch.
|
profiles.
|
||||||
|
|
||||||
`suites` are defined in the `importables` argument in either the `home` or `nixos`
|
`suites` are defined in the `importables` argument in either the `home` or `nixos`
|
||||||
namespace. They are a special case of an `importable` which get passed as a special
|
namespace. They are a special case of an `importable` which get passed as a special
|
||||||
|
|
|
@ -1,10 +1,10 @@
|
||||||
# get
|
# get
|
||||||
The `get` subcommand is useful for getting a bare copy of devos without the
|
The `get` subcommand is useful for getting a bare copy of devos without the
|
||||||
git history. You can pull either the core or community branches.
|
git history.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
```sh
|
```sh
|
||||||
flk get BRANCH DEST-DIR
|
flk get DEST-DIR
|
||||||
```
|
```
|
||||||
|
|
||||||
If DEST-DIR is ommitted, it defaults to _./flk_.
|
If DEST-DIR is ommitted, it defaults to _./devos_.
|
||||||
|
|
|
@ -25,8 +25,6 @@ version required.
|
||||||
In addition, the [binary cache](../integrations/cachix.md) is added for faster deployment.
|
In addition, the [binary cache](../integrations/cachix.md) is added for faster deployment.
|
||||||
|
|
||||||
> ##### _Notes:_
|
> ##### _Notes:_
|
||||||
> - You can change `core` to [`community`](../../index.md#community-profiles)
|
|
||||||
> in the call to `flk get`
|
|
||||||
> - Flakes ignore files that have not been added to git, so be sure to stage new
|
> - Flakes ignore files that have not been added to git, so be sure to stage new
|
||||||
> files before building the system.
|
> files before building the system.
|
||||||
> - You can choose to simply clone the repo with git if you want to follow
|
> - You can choose to simply clone the repo with git if you want to follow
|
||||||
|
|
Loading…
Reference in a new issue