Skip to content

Commit b013345

Browse files
committed
README.md: Add build and install instructions
Closes: #7
1 parent b247cf4 commit b013345

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,30 @@
11
# rust-accumulator
22
An optimized rust lib for a POC vector commitment scheme over a BLS based PCS
3+
4+
The recommended way to install this library/dependency is via Nix, but
5+
if you are stubborn and would prefer to do it manually, read on.
6+
7+
## Build and Install
8+
9+
This repo contains a `Makefile` with all the standard `Make` targets.
10+
The `Makefile` only builds the static library.
11+
12+
When this library is used by other packages, `pkg-config` is used to
13+
find the correct `CFLAGS` and `LIBS` settings so the `Makefile` also
14+
contains a `make pkgconfig` target.
15+
16+
Assuming you have the `cargo` (Rust build tool) installed (installing
17+
`cargo` will probably pull in everything else needed) you only need to
18+
specify an `INSTALL` directory.
19+
20+
It is sensible to have a user local install path for libraries.
21+
Something like `$HOME/Local` and to then set the following environment
22+
variable set:
23+
```
24+
PKG_CONFIG_PATH=$HOME/Local/lib/pkgconfig
25+
```
26+
27+
Building an installing this Rust library is as simple as:
28+
```
29+
INSTALL=$HOME/Local make install
30+
```

0 commit comments

Comments
 (0)