Add explanation for project creation and simplify installation docs

This commit is contained in:
kake26 2025-04-15 12:46:48 -05:00
parent e994049580
commit 521ec5161f
Signed by: kake26
GPG key ID: E0A989B571D1F99F
2 changed files with 6 additions and 6 deletions

View file

@ -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.

@ -1 +0,0 @@
Subproject commit 5196d165b945133f2777a3079912e11ee31c35a2