Packages

Clifford algebra for Elixir (initial project scaffold).

Current section

Files

Jump to
clifford README.md
Raw

README.md

# Clifford

An Elixir project for Clifford algebra.

This is an initial Mix scaffold. Algebra operations are not implemented yet.

## Installation

After the first release is published to Hex, add `clifford` to your dependencies:

```elixir
def deps do
  [
    {:clifford, "~> 0.1.0"}
  ]
end
```

## Development

Requires Elixir 1.20 or later in the 1.x series.

```sh
mix deps.get
mix test
mix docs
```

## Publishing

Review the description, version, and changelog against the actual API before
publishing. The repository URL is not configured yet; add it to `package.links`
and `source_url` when it exists.

Run the local checks and inspect the package file list:

```sh
mix format --check-formatted
mix test
mix docs
mix hex.build
```

This builds documentation and a local package archive; it does not publish.
To publish the reviewed release using your Hex account:

```sh
mix hex.user auth
mix hex.publish
```

See the [Hex publishing guide](https://hex.pm/docs/publish).

## License

MIT. See [LICENSE](LICENSE).