From f9ba8215f76a58e70656672256d9f008717c1646 Mon Sep 17 00:00:00 2001 From: Sokhibjon Orzikulov Date: Tue, 18 Jun 2024 21:15:26 +0500 Subject: [PATCH] Update README.md --- README.md | 55 ------------------------------------------------------- 1 file changed, 55 deletions(-) diff --git a/README.md b/README.md index 3ae4e21..ecaa220 100644 --- a/README.md +++ b/README.md @@ -1,60 +1,5 @@ # nixos-hetzner-robot-starter -This repository is intended to be a sane, batteries-included starter template -for running a LunarVim-powered remote NixOS development environment on a -Hetzner Robot dedicated server. It exists as a sister-project of -[nixos-wsl-starter](https://github.com/lgug2z/nixos-wsl-starter) and -[nixos-hetzner-cloud-starter](https://github.com/lgug2z/nixos-hetzner-cloud-starter). - -If you don't want to dig into NixOS too much right now, the only file you need -to concern yourself with is [home.nix](home.nix). This is where you can add and -remove binaries to your global `$PATH`. - -Go to [https://search.nixos.org](https://search.nixos.org/packages) to find the -correct package names, though usually they will be what you expect them to be -in other package managers. - -`unstable-packages` is for packages that you want to always keep at the latest -released versions, and `stable-packages` is for packages that you want to track -with the current release of NixOS (currently 24.05). - -If you want to update the versions of the available `unstable-packages`, run -`nix flake update` to pull the latest version of the Nixpkgs repository and -then apply the changes. - -Make sure to look at all the `FIXME` notices in the various files which are -intended to direct you to places where you may want to make configuration -tweaks. - -If you found this starter template useful, please consider -[sponsoring](https://github.com/sponsors/LGUG2Z) and [subscribing to my YouTube -channel](https://www.youtube.com/channel/UCeai3-do-9O4MNy9_xjO6mg?sub_confirmation=1). - -## What Is Included - -This starter is a lightly-opinionated take on a productive terminal-driven -development environment based on my own preferences. However, it is trivial to -customize to your liking both by removing and adding tools that you prefer. - -* The default editor is `lvim` -* The default shell is `zsh` -* `docker` is enabled by default -* The prompt is [Starship](https://starship.rs/) -* [`fzf`](https://github.com/junegunn/fzf), - [`lsd`](https://github.com/lsd-rs/lsd), - [`zoxide`](https://github.com/ajeetdsouza/zoxide), and - [`broot`](https://github.com/Canop/broot) are integrated into `zsh` by - default - * These can all be disabled easily by setting `enable = false` in - [home.nix](home.nix), or just removing the lines all together -* [`direnv`](https://github.com/direnv/direnv) is integrated into `zsh` by - default -* `git` config is generated in [home.nix](home.nix) with options provided to - enable private HTTPS clones with secret tokens -* `zsh` config is generated in [home.nix](home.nix) and includes git aliases, - useful WSL aliases, and - [sensible`$WORDCHARS`](https://lgug2z.com/articles/sensible-wordchars-for-most-developers/) - ## Quickstart [![Watch the walkthrough video](https://img.youtube.com/vi/nlX8g0NXW1M/hqdefault.jpg)](https://www.youtube.com/watch?v=nlX8g0NXW1M)