https://github.com/antoinegagne/poseidon

https://github.com/antoinegagne/poseidon

Last synced: 11 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/antoinegagne/poseidon
• Owner: AntoineGagne
• License: other
• Created: 2022-11-11T20:52:25.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2022-11-19T23:18:22.000Z (about 2 years ago)
• Last Synced: 2024-10-24T23:29:36.196Z (about 2 months ago)
• Language: Erlang
• Size: 14.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# poseidon

## Dependencies

* [OTP 24+](https://www.erlang.org/)

* [`rebar3`](https://www.rebar3.org/)

* [Rust](https://www.rust-lang.org/)

## Development

### Building

To compile this library, the following command can be used:

```sh

rebar3 compile

```

### Running Checks

To run all the checks, it is possible to use the `check` alias:

```sh

rebar3 check

```

This will run all the tests (`eunit`, Common Tests and `proper` tests) along

with `xref`, `dialyzer`, `edoc` and code coverage.

### Running Interactively

To run the library inside an interactive Erlang shell, the following command

may be used:

```sh

rebar3 shell

```

## Licensing

This software is licensed under the BSD3 license.