https://github.com/tomekw/cotd

Clojure of the day
https://github.com/tomekw/cotd

clojure documentation graal-native graalvm learning learning-clojure

Last synced: 3 months ago
JSON representation

Clojure of the day

• Host: GitHub
• URL: https://github.com/tomekw/cotd
• Owner: tomekw
• Created: 2012-11-26T21:10:51.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2020-06-09T07:39:20.000Z (over 4 years ago)
• Last Synced: 2024-08-09T17:29:59.850Z (6 months ago)
• Topics: clojure, documentation, graal-native, graalvm, learning, learning-clojure
• Language: Shell
• Homepage: https://github.com/tomekw/cotd
• Size: 6.84 KB
• Stars: 27
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
# cotd

Clojure of the day: it displays random documentation for function from `clojure.core` namespace.

## Usage

Download the binary from the releases page: https://github.com/tomekw/cotd/releases.

```bash

$ ./cotd

-------------------------

clojure.core/read

([] [stream] [stream eof-error? eof-value] [stream eof-error? eof-value recursive?] [opts stream])

  Reads the next object from stream, which must be an instance of

  java.io.PushbackReader or some derivee.  stream defaults to the

  current value of *in*.

  Opts is a persistent map with valid keys:

    :read-cond - :allow to process reader conditionals, or

                 :preserve to keep all branches

    :features - persistent set of feature keywords for reader conditionals

    :eof - on eof, return value unless :eofthrow, then throw.

           if not specified, will throw

  Note that read can execute code (controlled by *read-eval*),

  and as such should be used only with trusted sources.

  For data structure interop use clojure.edn/read

```

## Building

Tweak `GRAALVM_HOME` and `JAVA_HOME` in `script/build.sh` and run it.