README.md

# llama-treks

[![Build Status][gh-actions-badge]][gh-actions]
[![LFE Versions][lfe-badge]][lfe]
[![Erlang Versions][erlang-badge]][version]
[![Tags][github-tags-badge]][github-tags]

[![Project Logo][logo]][logo-large]

*A pure LFE matrix, linear algebra library*

##### Table of Contents

* [About](#about-)
* [Build](#build-)
* [Start the Project REPL](#start-the-repl-)
* [Tests](#tests-)
* [Usage](#usage-)
* [License](#license-)

## About [↟](#table-of-contents)

TBD

## Build [↟](#table-of-contents)

```shell
rebar3 lfe compile
```

## Start the Project REPL [↟](#table-of-contents)

```shell
rebar3 lfe repl
```

Or, to use the customised coloured prompt:

```shell
make repl
```

## Tests [↟](#table-of-contents)

```shell
rebar3 as test lfe ltest
```

## Usage [↟](#table-of-contents)

TBD

## License [↟](#table-of-contents)

Apache License, Version 2.0

Copyright © 2025, Duncan McGreggor <oubiwann@gmail.com>.

[//]: ---Named-Links---

[logo]: priv/images/llama8-small.jpg
[logo-large]: priv/images/llama8.png
[gh-actions-badge]: https://github.com/lfex/llama-treks/actions/workflows/cicd.yml/badge.svg
[gh-actions]: https://github.com/lfex/llama-treks/actions/workflows/cicd.yml
[lfe]: https://github.com/lfe/lfe
[lfe-badge]: https://img.shields.io/badge/lfe-2.2-blue.svg
[erlang-badge]: https://img.shields.io/badge/erlang-24%20to%2028-blue.svg
[version]: https://github.com/lfex/llama-treks/blob/main/.github/workflows/cicd.yml
[github-tags]: https://github.com/lfex/llama-treks/tags
[github-tags-badge]: https://img.shields.io/github/tag/lfex/llama-treks.svg