aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Ankarström <john@ankarstrom.se>2021-06-08 21:28:46 +0200
committerJohn Ankarström <john@ankarstrom.se>2021-06-08 21:28:46 +0200
commit7f34ce14a677e8b47a4953a61f32197332466359 (patch)
tree76885e2e7b4844a3553c0017338090073216bfa1
parent8fc24b5e1498756e327a451435675fb6c61e4ba9 (diff)
downloadrepl-7f34ce14a677e8b47a4953a61f32197332466359.tar.gz
Update README
-rw-r--r--README37
-rw-r--r--README.md87
2 files changed, 37 insertions, 87 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..1370d60
--- /dev/null
+++ b/README
@@ -0,0 +1,37 @@
+repl creates a read-eval-print loop out of any command. It is a
+simple and readable C program that requires GNU readline.
+
+In other words, it's a REPL for command-line interfaces that always
+require a "prefix" command. If you're tired of having to type git
+everytime you want to issue a git command:
+
+ $ git init
+ $ git add .
+ $ git status
+ $ git commit
+ $ git push
+ $ git status
+
+... then you can do this instead:
+
+ $ repl git
+ git& init
+ git& add .
+ git& status
+ git& commit
+ git& push
+ git& status
+
+The program automatically prefixes each command with git, so that
+you don't have to type it.
+
+### Installation
+
+First, edit the Makefile to set it up for your system.
+
+Then, issue the following commands:
+
+ $ make
+ $ make install
+
+To uninstall repl, run make uninstall.
diff --git a/README.md b/README.md
deleted file mode 100644
index 47066c4..0000000
--- a/README.md
+++ /dev/null
@@ -1,87 +0,0 @@
-`repl.c` creates a read-eval-print loop out of any command. It is
-a simple and readable C program that requires GNU readline.
-
-In other words, it's a REPL for command-line interfaces that always
-require a "prefix" command. If you're tired of having to type `git`
-everytime you want to issue a `git` command:
-
- $ git init
- $ git add .
- $ git status
- $ git commit
- $ git push
- $ git status
-
-... then you can do this instead:
-
- $ repl git
- git > init
- git > add .
- git > status
- git > commit
- git > push
- git > status
-
-The program automatically prefixes each command with `git`, so that
-you don't have to type it.
-
-### Installation
-
-The following commands install `repl` in `/usr/local/bin` and
-`repl.1`, its man page, in `/usr/local/man`:
-
- $ make
- $ make install
-
-If you want to install it somewhere different from `/usr/local`,
-edit the Makefile and modify the `PREFIX` variable.
-
-To uninstall both binary and man page, run `make uninstall`.
-
-***
-
-REPL(1) - General Commands Manual
-
-### NAME
-
-**repl** - create a REPL out of any command
-
-### SYNPOSIS
-
-**repl**
-*command*
-
-### DESCRIPTION
-
-When invoked, the
-**repl**
-utility puts the user in a read-eval-print loop, in which it reads
-input from the user, appends it to the
-*command*
-provided by the single argument, and lets the shell evaluate the
-full string.
-
-Built on GNU readline, it supports history and Emacs key bindings.
-
-**repl**
-is useful for command-line interfaces built on a
-"prefix command"
-that has to be typed over and over preceding the actual command, like
-git(1).
-
-### EXAMPLES
-
- $ repl git
- git > status
- On branch master
- Your branch is up to date with 'origin/master'.
- git >
-
-### AUTHORS
-
-**repl**
-is written by
-John Ankarstr&#246;m,
-available {on the web|by e-mail} at john{.|@}ankarstrom.se.
-
-OpenBSD 6.4 - January 10, 2019