Skip to content

Add manual building instructions to README.md #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 9, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,26 @@ resulting in free implementations for:

## Building

### Building using devx shell

Building is performed with `cabal`inside IOG's `github:input-output-hk/devx` shell.
See `.envrc` for details.

Make sure to `cabal update` before building.

### Building manually

*Unsupported method: do on your own risk. Was tested on Arch Linux in 2024.*

Manual installation for required binary dependencies is described here:
https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/getting-started/install.md#installing-blst
Arch Linux has libblst in AUR, which is alternative for building it manually.

After installing binary dependencies `cabal build` should work.

## Running tests

Tests are runned in emulated environment using
[CLB](https://github.com/mlabs-haskell/clb).

Just run: `cabal run cem-script-test`.
Just run: `cabal run cem-script-test`.