Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Alesfatalis committed Apr 13, 2024
1 parent 0e5ae66 commit 7562ea7
Showing 1 changed file with 70 additions and 2 deletions.
72 changes: 70 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,76 @@
# ergo-lib-go
Go wrapper around C bindings for ErgoLib from [sigma-rust](https://github.com/ergoplatform/sigma-rust)

### Status
Package is still work in progress and will likely change in the future
### Install
```
go get -u https://github.com/sigmaspace-io/ergo-lib-go
```

### Supported Platforms
This library makes heavy use of cgo. A set of precompiled shared library objects are provided. For the time being the following platforms are supported and tested against:

<table>
<thead>
<tr>
<th>Platform</th>
<th>Architecture</th>
<th>Triple</th>
<th>Supported</th>
<th>Tested</th>
</tr>
</thead>
<tbody>
<tr>
<td rowspan="2">Linux</td>
<td><code>amd64</code></td>
<td><code>x86_64-unknown-linux-gnu</code></td>
<td>✅</td>
<td>✅</td>
</tr>
<tr>
<td><code>aarch64</code></td>
<td><code>aarch64-unknown-linux-gnu</code></td>
<td>✅</td>
<td>⏳</td>
</tr>
<tr>
<td rowspan="2">Darwin</td>
<td><code>amd64</code></td>
<td><code>x86_64-apple-darwin</code></td>
<td>✅</td>
<td>✅</td>
</tr>
<tr>
<td><code>aarch64</code></td>
<td><code>aarch64-apple-darwin</code></td>
<td>⏳</td>
<td>⏳</td>
</tr>
<tr>
<td>Windows</td>
<td><code>amd64</code></td>
<td><code>x86_64-pc-windows-msvc</code></td>
<td>⏳</td>
<td>⏳</td>
</tr>
</tbody>
</table>

### Supported sigma-rust versions
<table>
<thead>
<tr>
<th>sigma-rust Version</th>
<th>ergo-lib-go Version</th>
</tr>
</thead>
<tbody>
<tr>
<td>v0.26.0</td>
<td>v0.26.0</td>
</tr>
</tbody>
</table>

### Library
The libraries under `lib` where compiled from `sigma-rust` with the following commands:
Expand Down

0 comments on commit 7562ea7

Please sign in to comment.