Add explanation for project creation and simplify installation docs
This commit is contained in:
parent
e994049580
commit
521ec5161f
2 changed files with 6 additions and 6 deletions
11
README.md
11
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.
|
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
|
## Dependencies
|
||||||
|
|
||||||
- DBI
|
- DBI
|
||||||
|
@ -27,7 +31,7 @@ If they are not marked as part of the source for the shell, you will need to ins
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
1. Install dependencies:
|
1. Install dependencies(recommended way):
|
||||||
```
|
```
|
||||||
cpanm --installdeps .
|
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
|
## Usage
|
||||||
|
|
||||||
- Type commands as you would in a normal shell
|
Run it and treat it as a shell.
|
||||||
- Type 'exit' to quit
|
|
||||||
- Command history is stored in `pshell_history.db`
|
|
||||||
- Environment variables are stored in `pshell_env.db`
|
|
||||||
|
|
|
@ -1 +0,0 @@
|
||||||
Subproject commit 5196d165b945133f2777a3079912e11ee31c35a2
|
|
Loading…
Add table
Add a link
Reference in a new issue