about summary refs log tree commit diff
path: root/users/sterni/clhs-lookup/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'users/sterni/clhs-lookup/README.md')
-rw-r--r--users/sterni/clhs-lookup/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/users/sterni/clhs-lookup/README.md b/users/sterni/clhs-lookup/README.md
new file mode 100644
index 0000000000..1f42ff43a2
--- /dev/null
+++ b/users/sterni/clhs-lookup/README.md
@@ -0,0 +1,13 @@
+# clhs-lookup
+
+Simple cli to lookup symbols' documentation in a local copy of the
+Common Lisp HyperSpec.
+
+## usage
+
+```
+clhs-lookup [--print] symbol [symbol [...]]
+
+  --print  Print documentation paths to stdout instead of
+           opening them with $BROWSER (defaults to xdg-open).
+```