Skip to content
This repository has been archived by the owner on Sep 1, 2023. It is now read-only.

Commit

Permalink
docs: update README with local installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
PascalinDe committed May 22, 2023
1 parent e6d6855 commit 80d9017
Showing 1 changed file with 21 additions and 8 deletions.
29 changes: 21 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,39 @@

# Stainless-ByzCoin Demonstrator

Stainless is a tool to help designing highly reliable programs in Scala. Using Formal Verification, it will check
whether the system behaves according to how it was specified, or if it will deviate in unexpected ways.
Logical errors, security vulnerabilities and other defects can therefore be detected before the program is deployed.

Please refer to the [project's showcase](https://factory.c4dt.org/showcase/stainless-for-smart-contracts/presentation)
for additional information on the project's theoretical background.

Steps to run locally:

You first need to generate the node's configs
```
make configs
```
Install `Go` by [following the official instructions for your OS](https://go.dev/doc/install), then
download the appropriate `Protocol Buffers` [archive for your architecture](https://github.com/protocolbuffers/protobuf/releases)
and extract it into this directory.

You need to add the extracted binary to the path your OS is searching for executables, e.g. via

If you want our prebuilt images
```
docker-compose pull
PATH=$PATH:$(pwd)/bin
```
Else if you want to build the images yourself

in Linux.

Generate the node's configs

```
make configs
make webapp-proto
docker-compose build
```

Launch it with

```
docker-compose up
```

And open a browser to http://localhost:80/stainless-demo/
And open a browser to http://localhost:80/stainless-demo/.

0 comments on commit 80d9017

Please sign in to comment.