Skip to content

Commit

Permalink
Consolidate wheel readme into main (#465)
Browse files Browse the repository at this point in the history
  • Loading branch information
Rigidity authored Sep 16, 2024
1 parent 1601e74 commit 6daaefb
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 36 deletions.
37 changes: 36 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The cargo workspace includes an rlib crate, for use with rust or other applicati

The python wheel is in `wheel`. The npm package is in `wasm`.

## TESTS
## Tests

In order to run the unit tests, run:

Expand Down Expand Up @@ -34,3 +34,38 @@ cargo fuzz run fuzz_run_program --jobs=32 -- -rss_limit_mb=4096
But with whatever number of jobs works best for you.

If you find issues in `clvm_rs` please use our [bug bounty program](https://hackerone.com/chia_network).

## Build Wheel

The `clvm_rs` wheel has python bindings for the rust implementation of clvm.

Use `maturin` to build the python interface. First, install into current virtualenv with

```
$ pip install maturin
```

While in the `wheel` directory, build `clvm_rs` into the current virtualenv with

```
$ maturin develop --release
```

On UNIX-based platforms, you may get a speed boost on `sha256` operations by building
with OpenSSL.

```
$ maturin develop --release --features=openssl
```

To build the wheel, do

```
$ maturin build --release
```

or

```
$ maturin build --release --features=openssl
```
2 changes: 1 addition & 1 deletion wheel/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ license = "Apache-2.0"
description = "Implementation of `clvm` for Chia Network's cryptocurrency"
homepage = "https://github.com/Chia-Network/clvm_rs/"
repository = "https://github.com/Chia-Network/clvm_rs/"
readme = "README.md"
readme = "../README.md"

[lib]
name = "clvm_rs"
Expand Down
34 changes: 0 additions & 34 deletions wheel/README.md

This file was deleted.

0 comments on commit 6daaefb

Please sign in to comment.