aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJonas Maier <>2026-04-17 16:17:32 +0200
committerJonas Maier <>2026-04-17 16:17:32 +0200
commitddd2627360ee7a30b26cd3b7fab19ede55c574d7 (patch)
treea1cc858709a7c2a03e8df85807b6947a108c972c
parentca15f61f9bd9067052fca0147d053bf8c9ffe49e (diff)
downloadpish-ddd2627360ee7a30b26cd3b7fab19ede55c574d7.tar.gz
document that /etc/shells needs to be modified
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7888b98
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# pish
+
+This is a shell written in Rust.
+
+## Building it
+- Have rust/cargo installed
+- `cargo build`
+
+## Trying it out
+- `cargo run`
+
+## Installing it
+- put the binary at a path that is useful to you, like `/usr/bin/pish`
+- allow the shell to be used for login by putting `/usr/bin/pish` into `/etc/shells`
+- adjust your shell in `/etc/passwd`
+