rm: community

the commmunity branch was fallen too far behind and there where no
contributions to it, anyways. We will start linking usage examples
out in the wild, instead.
This commit is contained in:
David Arnold 2021-07-16 12:45:48 -05:00
parent 4b9cab40cb
commit b95189d754
No known key found for this signature in database
GPG key ID: AB15A6AF1101390D
8 changed files with 9 additions and 36 deletions

View file

@ -33,10 +33,6 @@ Also, have a look at [_flake.nix_][toc]. If anything is not immediately
discoverable from there through [`digga`][digga] library's [`mkFlake`][mk-flake], discoverable from there through [`digga`][digga] library's [`mkFlake`][mk-flake],
please file a bug report. please file a bug report.
## In the Wild
The author maintains his own branch, so you can take inspiration, direction, or
make critical comments about the [code][please]. 😜
## Motivation ## Motivation
NixOS provides an amazing abstraction to manage our environment, but that new NixOS provides an amazing abstraction to manage our environment, but that new
power can sometimes bring feelings of overwhelm and confusion. Having a turing power can sometimes bring feelings of overwhelm and confusion. Having a turing
@ -46,16 +42,9 @@ and its satellite projects, from which best practices can evolve.
___The future is declarative! 🎉___ ___The future is declarative! 🎉___
## Community Profiles ## Examples in the Wild
There are two branches from which to choose: [core][core] and The author maintains his own branch, so you can take inspiration, direction, or
[community][community]. The community branch builds on core and includes make critical comments about the [code][please]. 😜
several ready-made profiles for discretionary use.
Every package and NixOS profile declared in community is uploaded to
[cachix](./integrations/cachix.md), so everything provided is available
without building anything. This is especially useful for the packages that are
[overridden](./concepts/overrides.md) from master, as without the cache,
rebuilds are quite frequent.
## Shoulders ## Shoulders
This work does not reinvent the wheel. It stands on the [shoulders of the This work does not reinvent the wheel. It stands on the [shoulders of the

View file

@ -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:

View file

@ -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`

View file

@ -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

View file

@ -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_.

View file

@ -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

View file

@ -2,7 +2,7 @@
bud.cmds = with pkgs; { bud.cmds = with pkgs; {
get = { get = {
writer = budUtils.writeBashWithPaths [ nixUnstable git coreutils ]; writer = budUtils.writeBashWithPaths [ nixUnstable git coreutils ];
synopsis = "get (core|community) [DEST]"; synopsis = "get [DEST]";
help = "Copy the desired template to DEST"; help = "Copy the desired template to DEST";
script = ./get.bash; script = ./get.bash;
}; };

View file

@ -1,6 +1 @@
if [[ "$1" == "core" || "$1" == "community" ]]; then nix flake new -t "github:divnix/devos/core" "${2:-devos}"
nix flake new -t "github:divnix/devos/$1" "${2:-devos}"
else
echo "bud get (core|community) [DEST]"
exit 1
fi