aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2016-03-02 14:31:19 +1300
committerTom Ryder <tom@sanctum.geek.nz>2016-03-02 14:31:19 +1300
commit17cb7df7c27256fce0f2a4e58efefe54934586ff (patch)
tree57e45ab1b73d5655eade2e6df2f6818f0feaf88b
parent>implying there's a man page (diff)
downloadspsh-17cb7df7c27256fce0f2a4e58efefe54934586ff.tar.gz
spsh-17cb7df7c27256fce0f2a4e58efefe54934586ff.zip
Add a README
-rw-r--r--README.markdown45
1 files changed, 45 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown
new file mode 100644
index 0000000..100dd49
--- /dev/null
+++ b/README.markdown
@@ -0,0 +1,45 @@
+sps: the shitposting shell
+==========================
+
+An experimental Bourne-style shell for me to learn moar C. Don't actually use
+this for any serious reason.
+
+You need to fully-qualify the programs and arguments you call at the moment,
+like:
+
+ sps$ /bin/grep pattern /home/user/file
+
+Installing
+----------
+
+ $ sudo apt-get install build-essential libreadline6-dev
+ $ make
+
+Working
+-------
+
+* Readline keys
+* Commands (with fully-qualified paths) and arguments
+* ^D to exit
+
+Not working but planned
+-----------------------
+
+In rough order of priority:
+
+* At least a few simple builtins, like "cd" and "exit"
+* $PATH so you don't have to fully qualify all your programs
+* Environment variables
+* Quoting/escaping arguments (i.e. something better than just strtok())
+* Command history
+
+Author
+------
+
+Tom Ryder <tom@sanctum.geek.nz>
+
+License
+-------
+
+GPL 2.0 (because Readline)
+