From a81930af36be9f78484ce16e95409f4f56064f93 Mon Sep 17 00:00:00 2001 From: David Arnold Date: Wed, 19 May 2021 20:15:49 -0400 Subject: [PATCH] readme: declare it beta and update some other things --- README.md | 60 ++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 46 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index ef7ed23e..f347f4a2 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,8 @@ > maturing _well_ [for a while](https://github.com/divnix/devos/tree/17713c22d07c54525c728c62060a0428b76dee3b). # Introduction -DevOS grants a simple way to use, deploy and manage [NixOS][nixos] systems for -personal and productive use. A sane repository structure is provided, +DevOS grants a simple template to use, deploy and manage [NixOS][nixos] systems +for personal and productive use. A sane repository structure is provided, integrating several popular projects like [home-manager][home-manager], [devshell][devshell], and [more](./doc/integrations). @@ -21,14 +21,17 @@ a [flake centric][flake-doc] approach is taken for useful conveniences such as Skip the indeterminate nature of other systems, _and_ the perceived tedium of bootstrapping Nix. It's easier than you think! -### Status: Alpha -A lot of the implementation is less than perfect, and huge -[redesigns](https://github.com/divnix/devos/issues/152) _will_ happen. There -are unstable versions (0._x_._x_) to help users keep track of changes and -progress. +### 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. ## 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 from there through [`digga`][digga] library's [`mkFlake`][mk-flake], +please file a bug report. ## In the Wild The author maintains his own branch, so you can take inspiration, direction, or @@ -43,12 +46,6 @@ and its satellite projects, from which best practices can evolve. ___The future is declarative! 🎉___ -## Upstream -I'd love to see this in the nix-community should anyone believe its reached a -point of maturity to be generally useful, but I'm all for waiting until -1.0[#121](https://github.com/divnix/devos/issues/121) to save the cache work, -too. - ## Community Profiles There are two branches from which to choose: [core][core] and [community][community]. The community branch builds on core and includes @@ -60,6 +57,22 @@ 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 +This work does not reinvent the wheel. It stands on the [shoulders of the +following giants][giants]: + +### :onion: — like the layers of an onion +- [`divnix/digga`][digga] +- [`gytis-ivaskevicius/flake-utils-plus`][fup] +- [`numtide/flake-utils`][fu] + +### :family: — like family +- [`numtide/devshell`][devshell] +- [`serokell/deploy-rs`][deploy] +- [`NixOS/nixpkgs`][nixpkgs] + +:heart: + ## Inspiration & Art - [hlissner/dotfiles][dotfiles] - [nix-user-chroot](https://github.com/nix-community/nix-user-chroot) @@ -67,9 +80,29 @@ rebuilds are quite frequent. - [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. + # License DevOS is licensed under the [MIT License][mit]. +[mk-flake]: https://github.com/divnix/digga/tree/master/src/mkFlake +[nixpkgs]: https://github.com/NixOS/nixpkgs +[deploy]: https://github.com/serokell/deploy-rs +[toc]: https://github.com/divnix/devos/blob/core/flake.nix +[giants]: https://en.wikipedia.org/wiki/Standing_on_the_shoulders_of_giants +[digga]: https://github.com/divnix/digga +[fup]: https://github.com/gytis-ivaskevicius/flake-utils-plus +[fu]: https://github.com/numtide/flake-utils +[devshell]: https://github.com/numtide/devshell [nix]: https://nixos.org/manual/nix/stable [mit]: https://mit-license.org [nixos]: https://nixos.org/manual/nixos/stable @@ -79,5 +112,4 @@ DevOS is licensed under the [MIT License][mit]. [core]: https://github.com/divnix/devos [community]: https://github.com/divnix/devos/tree/community [dotfiles]: https://github.com/hlissner/dotfiles -[devshell]: https://github.com/numtide/devshell [please]: https://github.com/nrdxp/devos/tree/nrd