From 6ff54657e1dcde6743178b3d52af255b09cc4844 Mon Sep 17 00:00:00 2001 From: Henrik Lissner Date: Sat, 2 Oct 2021 01:10:44 +1000 Subject: [PATCH] welcome incantation --- README.md | 62 +++++++++++++++---------------------------------------- 1 file changed, 17 insertions(+), 45 deletions(-) diff --git a/README.md b/README.md index 6607bb42..9b704a2c 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,31 @@ [![NixOS](https://img.shields.io/badge/NixOS-unstable-blue.svg?style=flat&logo=NixOS&logoColor=white)](https://nixos.org) [![MIT License](https://img.shields.io/github/license/divnix/devos)][mit] -[![Chat](https://img.shields.io/matrix/devos:nixos.org.svg?label=%23devos%3Anixos.org&logo=matrix&server_fqdn=matrix.org)][matrix] > #### ⚠ Advisory ⚠ -> DevOS requires the [flakes][flakes] feature available via an _experimental_ -> branch of [nix][nix]. Until nix 2.4 is released, this project -> should be considered unstable. - -### Why? -Make an awesome template for NixOS users, with consideration for common tools like [home-manager][home-manager], -[devshell][devshell], and [more](./doc/integrations). - -### No. Why _flakes_? -Flakes are a part of an explicit push to improve [Nix's UX](https://github.com/NixOS/nix/blob/master/doc/manual/src/contributing/cli-guideline.md), and have become an integral part of that effort. - -They also make [Nix expressions](https://nixos.org/manual/nix/unstable/expressions/expression-syntax.html) easier to distribute and reuse with convient [flake references](https://github.com/NixOS/nix/blob/master/src/nix/flake.md#flake-references) for building or using packages, modules, and whole systems. +> Do you remember how you got here? Where were you going? What were you leaving behind? +> Even if you cant't remember, I hope you remember what you were looking for. +> I hope you find it here. ## Getting Started -Check out the [guide](https://devos.divnix.com/start) to get up and running. -Also, have a look at [_flake.nix_][toc]. If anything is not immediately -discoverable via "[`digga`][digga]'s [`mkFlake`][mk-flake], -please file a bug report. +You can clone this directory to `/etc/nixos/` on a NixOS machine, with flakes installed. +Then you can summon a machine with `sudo nixos-rebuild test --flakes '/etc/nixos/#'` +For a list of machines inscribed in this spellbook look [here][here] +The rest is left as an exercise to the reader. -### Status: Beta -Although this project has already matured quite a bit, especially through -recent outfactoring of [`digga`][digga], a fair amount of api polishing is still -expected. There are unstable versions (0._x_._x_) to help users keep track -of changes and progress, and a [`develop`](https://github.com/divnix/devos/tree/develop) branch for the brave 😜 - -## In the Wild -* The original [authors][please] +### Status: Alpha +The volcanic rock still shifts below this structure. It has not solidified and cannot yet be considered `home` +You should not expect landmarks here. +Learn to adopt Chaos. ## Shoulders -This work does not reinvent the wheel. It stands on the [shoulders of the +Summoning is powerful magic, and cannot be created in isolation. It stands on the [shoulders of the following giants][giants]: ### :onion: — like the layers of an onion +- [`devos/devos`][devos] - [`divnix/digga`][digga] - [`gytis-ivaskevicius/flake-utils-plus`][fup] - [`numtide/flake-utils`][fu] - -### :family: — like family - [`numtide/devshell`][devshell] - [`serokell/deploy-rs`][deploy] - [`berberman/nvfetcher`][nvfetcher] @@ -48,23 +33,9 @@ following giants][giants]: :heart: -## Inspiration & Art -- [hlissner/dotfiles][dotfiles] -- [nix-user-chroot](https://github.com/nix-community/nix-user-chroot) -- [Nickel](https://github.com/tweag/nickel) -- [Awesome Nix](https://github.com/nix-community/awesome-nix) -- [devshell](https://github.com/numtide/devshell) - -## Divnix -The divnix org is an open space that spontaniously formed out of "the Nix". -It is really just a place where otherwise unrelated people a) get -together and b) stuff done. - -It's a place to stop "geeking out in isolation" (or within company boundaries), -experiment and learn together and iterate quickly on best practices. That's what it is. - -It might eventually become a non-profit if that's not too complicated or if those -goals are sufficiently upstreamed into "the Nix", dissolved. +### But Why? +The future is more uncertain than ever. Make dependable what you can, in whatever way you know how. +Stop doing it by yourself, unless we learn to work with one another will we be able to grow long term solutions. Perhaps together we can stop collapse. # License DevOS is licensed under the [MIT License][mit]. @@ -88,4 +59,5 @@ DevOS is licensed under the [MIT License][mit]. [nixpkgs]: https://github.com/NixOS/nixpkgs [nvfetcher]: https://github.com/berberman/nvfetcher [please]: https://github.com/nrdxp/devos/tree/nrd +[here]: https://anish.lakhwara.com/ops/machines