From 521ec5161f7c44a5727bdb82e9ef1df55056031a Mon Sep 17 00:00:00 2001 From: kake26 Date: Tue, 15 Apr 2025 12:46:48 -0500 Subject: [PATCH] Add explanation for project creation and simplify installation docs --- README.md | 11 ++++++----- src/pshell | 1 - 2 files changed, 6 insertions(+), 6 deletions(-) delete mode 160000 src/pshell diff --git a/README.md b/README.md index 2f820ef..2d70d08 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,10 @@ A modular Perl shell with SQLite command history and environment variables. No job control, but that is what programs like tmux are for anyway. Fairly, basic shell, but modular. This does depend on some modules. Also still a work in progress. +## Why did I create this? + +This was created entirely on a whim. I just want to get back to some Perl coding and see what crazy thing I can do. Turns out this is the result. Oddly, enough I will likely end up using this as my normal shell. Its not anything super shiny or amazing, but it does the basics the way I want it to. Especially the history without needing to add something like atuin. + ## Dependencies - DBI @@ -27,7 +31,7 @@ If they are not marked as part of the source for the shell, you will need to ins ## Installation -1. Install dependencies: +1. Install dependencies(recommended way): ``` cpanm --installdeps . ``` @@ -44,7 +48,4 @@ If they are not marked as part of the source for the shell, you will need to ins ## Usage -- Type commands as you would in a normal shell -- Type 'exit' to quit -- Command history is stored in `pshell_history.db` -- Environment variables are stored in `pshell_env.db` +Run it and treat it as a shell. diff --git a/src/pshell b/src/pshell deleted file mode 160000 index 5196d16..0000000 --- a/src/pshell +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 5196d165b945133f2777a3079912e11ee31c35a2