aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Tom Willemsen2013-03-22 02:44:09 +0100
committerGravatar Tom Willemsen2013-03-22 02:44:09 +0100
commit0adccf6b3e007df4fd1a8b124f55e339852967d5 (patch)
tree8c23a1e5059aa7d06fc8500c2c31ef913a5505a7
parent671d0fdcc71b21b80a7d3253ea542ace1a67f168 (diff)
downloadclark-0adccf6b3e007df4fd1a8b124f55e339852967d5.tar.gz
clark-0adccf6b3e007df4fd1a8b124f55e339852967d5.zip
Add README
-rw-r--r--README.org46
1 files changed, 46 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..a4cf161
--- /dev/null
+++ b/README.org
@@ -0,0 +1,46 @@
+#+TITLE: CLark
+
+* Name
+
+ clark - collect bookmarks on your command-line
+
+* Synopsis
+
+ =clark= <command> [<args> ...]
+
+* Description
+
+ CLark is a bookmark collection application for the command-line. It
+ is a drag being dependant on your browser or an internet connection
+ to be able to collect, manage and look through your bookmarks, so
+ we're breaking free... slowly.
+
+** CLark?! What the ...?
+
+ I've been working on this program for a long time, though not very
+ intensely, and it's gone through a few names.
+
+ At first I absolutely wanted to write it in C, and I named it
+ =linkwave=. I made a little program that could store given URLs with
+ names and descriptions, but not much else than that.
+
+ Then I started messing around with Lisp and some of its
+ derivatives, such as chicken scheme. And then I thought it would be
+ much cooler to (re)write this in scheme! I named it =markam=, because
+ Markam collects books.
+
+ Now, I'm thinking that it would be much cooler _still_ to write the
+ thing in Common Lisp! So I name it CLark, because it is Common
+ Lisp, and a rewrite of mARKam.
+
+* Commands
+
+ - =help= :: Prints a usage and help message, showing a list of
+ possible commands and some hints on how to use them.
+
+ - =version= :: Prints the CLark version and then quits.
+
+ - =add= :: Add a new bookmark to the database.
+
+ - =search= :: Search through the database looking for a partial match
+ on its name or an exact-matching tag.