From 3cd723bcd6a9437bffbee1a71a212383ca02dcff Mon Sep 17 00:00:00 2001 From: Anish Lakhwara Date: Tue, 6 Dec 2022 17:09:49 +1000 Subject: [PATCH] keep readme --- README.md | 93 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 93 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..e5edc638 --- /dev/null +++ b/README.md @@ -0,0 +1,93 @@ +[![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] + +> #### ⚠ Advisory ⚠ +> Do you remember how you got here? Where were you going? What were you leaving behind? +> Are you sure you want to go down this rabbit hole, Alice? + +## Getting Started +This is my personal deployment hub. I configure all my personal servers from this repo. Good luck if you're looking to graft this. +You'll probably want to run some `install.sh` that will configure the base NixOS system. Some of them aren't in a good state. +From there you can either install the host you want with `sudo nixos-rebuild switch --flake .#` or enter the cockpit with `nix develop` and deploy servers remotely through `deploy` + + +## Personal dotfiles + + +

+ + + +

+ +------ + +| | | +|----------------|----------------------------------------------------------| +| **Shell:** | bash / elvish | +| **DM:** | lightdm + lightdm-mini-greeter | +| **WM:** | bspwm + polybar | +| **Editor:** | nvim | +| **Terminal:** | kitty | +| **Launcher:** | rofi | +| **Browser:** | firefox | +| **GTK Theme:** | [Ant Dracula](https://github.com/EliverLara/Ant-Dracula) | + +----- + + +### Status: Beta +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 +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 +- [`divnix/digga`][digga] +- [`gytis-ivaskevicius/flake-utils-plus`][fup] +- [`numtide/flake-utils`][fu] +- [`numtide/devshell`][devshell] +- [`serokell/deploy-rs`][deploy] +- [`berberman/nvfetcher`][nvfetcher] +- [`NixOS/nixpkgs`][nixpkgs] +- Agenix +- direnv + +:heart: + +### 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. + +Managing servers by hand sucks, k8s doesn't allow me to transitively deploy all my configuration to multiple personal machines, and ansible wasn't good enough. + +You probably don't want to use nixOS, I'm a masocist + +### Grafts +https://github.com/hlissner/dotfiles + +# License +DevOS is licensed under the [MIT License][mit]. + +[community]: https://github.com/divnix/devos/tree/community +[core]: https://github.com/divnix/devos +[deploy]: https://github.com/serokell/deploy-rs +[devshell]: https://github.com/numtide/devshell +[digga]: https://github.com/divnix/digga +[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 +[fu]: https://github.com/numtide/flake-utils +[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 +[mit]: https://mit-license.org +[mk-flake]: https://github.com/divnix/digga/tree/master/src/mkFlake +[nix]: https://nixos.org/manual/nix/stable +[nixos]: https://nixos.org/manual/nixos/stable +[nixpkgs]: https://github.com/NixOS/nixpkgs +[nvfetcher]: https://github.com/berberman/nvfetcher +