From ea8539c929a8fb169e110f51b09f350858f3c0f7 Mon Sep 17 00:00:00 2001 From: pagedmov Date: Fri, 27 Feb 2026 09:59:12 -0500 Subject: [PATCH] Update README.md --- README.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 23f8f8e..f94335c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # shed -A Linux shell written in Rust. The name is a nod to both `sh` and `ed`. It's a shell with a heavy emphasis on smooth line editing. +A Linux shell written in Rust. The name is a nod to the original Unix utilities `sh` and `ed`. It's a shell with a heavy emphasis on smooth line editing. shed @@ -66,10 +66,6 @@ shed's scripting language contains all of the essentials. - `fg`, `bg`, `jobs`, `disown` with flags (`-l`, `-p`, `-r`, `-s`, `-h`, `-a`) - Process group management and proper signal forwarding -### Builtins - -`echo`, `cd`, `pwd`, `read`, `export`, `local`, `readonly`, `unset`, `source`, `eval`, `exec`, `shift`, `alias`, `unalias`, `trap`, `jobs`, `fg`, `bg`, `disown`, `pushd`, `popd`, `dirs`, `shopt`, `builtin`, `command`, `return`, `break`, `continue`, `exit`, `true`, `false`, `:` - ### Configuration Shell options are managed through `shopt`: @@ -91,6 +87,7 @@ The rc file is loaded from `~/.shedrc` on startup. Requires Rust (edition 2024). ```sh +git clone https://github.com/km-clay/shed.git cargo build --release ``` @@ -98,7 +95,7 @@ The binary will be at `target/release/shed`. ### Nix -A flake is provided with a NixOS module and a Home Manager module. +A flake is provided with a NixOS module, a Home Manager module, and a simple overlay that adds `pkgs.shed`. ```sh # Build and run directly @@ -126,6 +123,16 @@ Or with Home Manager: imports = [ shed.homeModules.shed ]; ``` +And the overlay: + +```nix +pkgs = import nixpkgs { + overlays = [ + shed.overlays.default + ]; +}; +``` + ## Status `shed` is experimental software and is currently under active development. It covers most day-to-day interactive shell usage and a good portion of POSIX shell scripting, but it is not yet fully POSIX-compliant. There is no guarantee that your computer will not explode when you run this. Use it at your own risk, the software is provided as-is.