pub-solar/os
5
0
Fork 2
Code Issues 4 Pull requests Packages Projects 1 Releases Wiki Activity
os/README.md

95 lines
4.4 KiB
Markdown
Raw Normal View History

README.md: update NixOS badge
2021-03-27 15:16:37 +00:00
[![NixOS](https://img.shields.io/badge/NixOS-unstable-blue.svg?style=flat&logo=NixOS&logoColor=white)](https://nixos.org)
README.md: rework
2021-07-02 05:40:55 +00:00
[![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]
README.md: add shields and useful links
2021-02-15 07:41:45 +00:00
README.md: advisory top
2021-02-18 00:07:44 +00:00
> #### ⚠ Advisory ⚠
treewide cleanups and refactoring for initial tests (#157) - [x] refactor lib into separate files, similar to NixOS/nixpkgs/lib. - [x] refactor ci to automatically generate derivations from flake outputs - [x] remove cluttered indirection statements throughout the codebase - [x] refactor hosts to allow for upcoming integration tests - [x] improve ambiguity in the existing docs - [x] add [BORS](https://bors.tech) support - [x] add initial integration test - [x] write tests documentation - [x] test lib - [x] improve version string generation, and do so automatically for pkgs/flake.nix sources Clean up the codebase as best we can in preparation for #152 and add tests. From now on, all PRs will be merged with BORS.
2021-03-14 07:10:51 +00:00
> DevOS requires the [flakes][flakes] feature available via an _experimental_
README.md: rework
2021-07-02 05:40:55 +00:00
> 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],
treewide cleanups and refactoring for initial tests (#157) - [x] refactor lib into separate files, similar to NixOS/nixpkgs/lib. - [x] refactor ci to automatically generate derivations from flake outputs - [x] remove cluttered indirection statements throughout the codebase - [x] refactor hosts to allow for upcoming integration tests - [x] improve ambiguity in the existing docs - [x] add [BORS](https://bors.tech) support - [x] add initial integration test - [x] write tests documentation - [x] test lib - [x] improve version string generation, and do so automatically for pkgs/flake.nix sources Clean up the codebase as best we can in preparation for #152 and add tests. From now on, all PRs will be merged with BORS.
2021-03-14 07:10:51 +00:00
[devshell][devshell], and [more](./doc/integrations).
README.md: rework
2021-07-02 05:40:55 +00:00
### No. Why _flakes_?
Fix typo in README.md
2021-08-11 19:05:03 +00:00
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.
README.md: refine the intro Emphasize the potentially ephemeral nature of the API until stability is reached.
2021-02-18 04:32:18 +00:00
README.md: rework
2021-07-02 05:40:55 +00:00
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.
README.md: status blurb
2021-03-01 05:33:14 +00:00
doc: finish `flk` reference
2021-02-15 00:41:15 +00:00
## Getting Started
README.md: fix guide link
2021-04-19 03:42:54 +00:00
Check out the [guide](https://devos.divnix.com/start) to get up and running.
fix/merge-conflict (#36) Co-authored-by: Anton <fetsorn@gmail.com> Co-authored-by: Chris Montgomery <chris@cdom.io> Co-authored-by: Timothy DeHerrera <tim.deh@pm.me> Reviewed-on: https://git.b12f.io/pub-solar/os/pulls/36 Co-authored-by: teutat3s <teutates@mailbox.org> Co-committed-by: teutat3s <teutates@mailbox.org>
2021-10-07 23:53:20 +00:00
Also, have a look at [_flake.nix_](./flake.nix). If anything is not immediately
README.md: rework
2021-07-02 05:40:55 +00:00
discoverable via "[`digga`][digga]'s [`mkFlake`][mk-flake],
readme: declare it beta and update some other things
2021-05-20 00:15:49 +00:00
please file a bug report.
doc: finish `flk` reference
2021-02-15 00:41:15 +00:00
README.md: rework
2021-07-02 05:40:55 +00:00
### 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 😜
doc: finish `flk` reference
2021-02-15 00:41:15 +00:00
README.md: rework
2021-07-02 05:40:55 +00:00
## In the Wild
README: Add more flakes to "in the wild" Remove the nrd branch, since that doesn't exist anymore
2022-01-14 03:57:34 +00:00
* @Pacman99: [Personal](https://gitlab.com/coffeetables/lower), [Server](https://gitlab.com/coffeetables/myrdd)
* [@danielphan2003](https://github.com/danielphan2003/flk) and make sure to also check out [devos-ext-lib][devos-ext-lib]
* [PubSolarOS](https://git.sr.ht/~b12f/pub-solar-os)
doc: finish `flk` reference
2021-02-15 00:41:15 +00:00
readme: declare it beta and update some other things
2021-05-20 00:15:49 +00:00
## Shoulders
This work does not reinvent the wheel. It stands on the [shoulders of the
following giants][giants]:
### :onion: &mdash; like the layers of an onion
- [`divnix/digga`][digga]
- [`gytis-ivaskevicius/flake-utils-plus`][fup]
- [`numtide/flake-utils`][fu]
### :family: &mdash; like family
- [`numtide/devshell`][devshell]
- [`serokell/deploy-rs`][deploy]
feature: Add pkgs fetch manager nvfetcher Co-authored-by: David Arnold <dar@xoe.solutions>
2021-06-14 04:48:43 +00:00
- [`berberman/nvfetcher`][nvfetcher]
readme: declare it beta and update some other things
2021-05-20 00:15:49 +00:00
- [`NixOS/nixpkgs`][nixpkgs]
:heart:
README.md: add shields and useful links
2021-02-15 07:41:45 +00:00
## 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)
readme: declare it beta and update some other things
2021-05-20 00:15:49 +00:00
## 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.
init
2019-12-03 05:18:30 +00:00
# License
project rename: nixflk -> devos
2021-02-18 01:31:33 +00:00
DevOS is licensed under the [MIT License][mit].
init
2019-12-03 05:18:30 +00:00
feature: Add pkgs fetch manager nvfetcher Co-authored-by: David Arnold <dar@xoe.solutions>
2021-06-14 04:48:43 +00:00
[community]: https://github.com/divnix/devos/tree/community
[core]: https://github.com/divnix/devos
readme: declare it beta and update some other things
2021-05-20 00:15:49 +00:00
[deploy]: https://github.com/serokell/deploy-rs
feature: Add pkgs fetch manager nvfetcher Co-authored-by: David Arnold <dar@xoe.solutions>
2021-06-14 04:48:43 +00:00
[devshell]: https://github.com/numtide/devshell
readme: declare it beta and update some other things
2021-05-20 00:15:49 +00:00
[digga]: https://github.com/divnix/digga
feature: Add pkgs fetch manager nvfetcher Co-authored-by: David Arnold <dar@xoe.solutions>
2021-06-14 04:48:43 +00:00
[dotfiles]: https://github.com/hlissner/dotfiles
[flake-doc]: https://github.com/NixOS/nix/blob/master/src/nix/flake.md
[flakes]: https://nixos.wiki/wiki/Flakes
readme: declare it beta and update some other things
2021-05-20 00:15:49 +00:00
[fu]: https://github.com/numtide/flake-utils
feature: Add pkgs fetch manager nvfetcher Co-authored-by: David Arnold <dar@xoe.solutions>
2021-06-14 04:48:43 +00:00
[fup]: https://github.com/gytis-ivaskevicius/flake-utils-plus
[giants]: https://en.wikipedia.org/wiki/Standing_on_the_shoulders_of_giants
[home-manager]: https://nix-community.github.io/home-manager
README.md: add shields and useful links
2021-02-15 07:41:45 +00:00
[mit]: https://mit-license.org
feature: Add pkgs fetch manager nvfetcher Co-authored-by: David Arnold <dar@xoe.solutions>
2021-06-14 04:48:43 +00:00
[mk-flake]: https://github.com/divnix/digga/tree/master/src/mkFlake
[nix]: https://nixos.org/manual/nix/stable
doc: finish `flk` reference
2021-02-15 00:41:15 +00:00
[nixos]: https://nixos.org/manual/nixos/stable
feature: Add pkgs fetch manager nvfetcher Co-authored-by: David Arnold <dar@xoe.solutions>
2021-06-14 04:48:43 +00:00
[nixpkgs]: https://github.com/NixOS/nixpkgs
[nvfetcher]: https://github.com/berberman/nvfetcher
README.md: promote upstreaming
2021-02-20 05:42:33 +00:00
[please]: https://github.com/nrdxp/devos/tree/nrd
chore: fix merge conflict (#34) Reviewed-on: https://git.b12f.io/pub-solar/os/pulls/34 Co-authored-by: teutat3s <teutates@mailbox.org> Co-committed-by: teutat3s <teutates@mailbox.org>
2021-10-07 23:40:32 +00:00
[matrix]: https://matrix.to/#/#devos:nixos.org
README: Add more flakes to "in the wild" Remove the nrd branch, since that doesn't exist anymore
2022-01-14 03:57:34 +00:00
[devos-ext-lib]: https://github.com/divnix/devos-ext-lib
Reference in a new issue Copy permalink