Liking cljdoc? Tell your friends :D

brain

An event looping abstraction to be used as the driving loop for a game engine, Elmish frontend, etc.

Important Links

builds.sr.ht status - ci.yml Clojars Project

Usage

Add net.clojars.jamesaorson/brain to your project

Leiningen/Boot

[net.clojars.jamesaorson/brain "0.0.1"]

Clojure CLI/deps.edn

net.clojars.jamesaorson/brain {:mvn/version "0.0.1"}

Gradle

implementation("net.clojars.jamesaorson:brain:0.0.1")

Maven

<dependency>
  <groupId>net.clojars.jamesaorson</groupId>
  <artifactId>brain</artifactId>
  <version>0.0.1</version>
</dependency>

Examples

Refer to main.clj for an ever-evolving, documenting example project, meant to demonstrate every feature of the engine simultaneously.

Over time, this will lead to the most wild and insane application you can imagine.

Please help to make it so.

Additional examples will come to live in their namesake

Local Development

Local Development - Setup

For Linux or MacOS, install Clojure via Brew:

Setup Clojure

# NOTE: https://brew.sh
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Add brew to your path...

brew install clojure/tools/clojure

Setup Leiningen

Install leiningen for your platform

For Debian/Ubuntu:

sudo apt-get install -y leiningen

For MacOS:

brew install leiningen

Setup Babashka

Install babashka

./scripts/install_babashka.bash

Setup jq

For Debian/Ubuntu:

sudo apt-get install -y jq

For MacOS:

brew install jq

Local Development - Lint

./scripts/lint.bb

Local Development - Build

./scripts/build.bb

Local Development - Run

./scripts/run.bb

Local Development - Test

./scripts/test.bb

Local Development - Submitting a PR

Simply click this link, and follow the instructions here to create a patchset, sending the patchset email to the following for the brain mailing list: ~jamesaorson/brain@lists.sr.ht

Can you improve this documentation?Edit on sourcehut

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close