almond

<div align="center">
<img src="docs/website/static/logos/impure-logos-almond-0.svg" alt="logo" width="40%">
</div>

# almond

*almond* is a [Scala](https://scala-lang.org) kernel for [Jupyter](https://jupyter.org).

[![Build Status](https://github.com/almond-sh/almond/actions/workflows/ci.yml/badge.svg)](https://github.com/almond-sh/almond/actions/workflows/ci.yml?query=branch%3Amain)
[![Join the chat at https://gitter.im/alexarchambault/jupyter-scala](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/alexarchambault/jupyter-scala?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Maven Central](https://img.shields.io/maven-central/v/sh.almond/kernel_2.12.svg)](https://maven-badges.herokuapp.com/maven-central/sh.almond/kernel_2.12)
[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/almond-sh/almond)

## Documentation

See the project [website](https://almond.sh) for more details

## Developer documentation

Find it in [`docs/pages/dev-from-sources.md`](https://github.com/almond-sh/almond/blob/main/docs/pages/dev-from-sources.md) in the sources for more details, and soon
[on the website](https://almond.sh/docs/dev-from-sources) when it will be
updated (it's currently out-of-date there).

## Code of Conduct

The almond project welcomes contributions from anybody wishing to participate.
All code or documentation that is provided must be licensed with the same
license that almond is licensed with (3-Clause BSD, see LICENSE).

People are expected to follow the [Scala Code of Conduct](https://www.scala-lang.org/conduct)
when discussing almond on GitHub, Gitter channel, or other venues.

Feel free to open an issue if you notice a bug, have an idea for a feature, or have a question about the code. Pull requests are also gladly accepted.