about summary refs log tree commit diff
path: root/users/sterni/clhs-lookup/README.md
diff options
context:
space:
mode:
authorsterni <sternenseemann@systemli.org>2021-01-29T17·22+0100
committersterni <sternenseemann@systemli.org>2021-01-29T17·36+0000
commit001ee91169c4e25bd3696fc3c69e5151f5547a7f (patch)
tree05e5c5019d1b0df8e119ab49468a32233b2e46a4 /users/sterni/clhs-lookup/README.md
parent1fb5a17f1430840da4990ffa35a04aca96f06d0a (diff)
feat(users/sterni): move clhs.clhs-lookup to clhs-lookup r/2151
This way ci should pick up on clhs-lookup since only a single derivation
is exposed with the default.nix and it is less cumbersome to type the
attribute path (users.sterni.clhs.clhs-lookup →
users.sterni.clhs-lookup). The exposed CLHS wasn't used for anything
anyways and I can always expose it again using passthru or extra if it's
ever merged.

Change-Id: I6c5aeba1b58ca650700c6efa0913e4b42685ea6b
Reviewed-on: https://cl.tvl.fyi/c/depot/+/2461
Tested-by: BuildkiteCI
Reviewed-by: sterni <sternenseemann@systemli.org>
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 000000000000..1f42ff43a210
--- /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).
+```