Skip to content

Commit 5b3435e

Browse files
committed
README.md: Add build and install instructions
Closes: #7
1 parent 621867e commit 5b3435e

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

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

0 commit comments

Comments
 (0)