Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Samuel committed Jul 9, 2021
1 parent 5a9704b commit cb99252
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Current implemented features:
## Installation

Requirements:
- Libsodium: for the ed25519 encryption and decryption.
- Libsodium: for the ed25519 to Curve25519 conversion
- OpenSSL 1.11
- OTP 23: generation of ed25519 key pairs
- GMP (https://gmplib.org/)
Expand All @@ -53,7 +53,8 @@ Platforms supported:
- Linux (Ubuntu 18.04)
- Mac OS X

Requires Cassandra/ScyllaDB installation to use for the backend storage
Requires ScyllaDB/Cassandra installation to use for the backend storage
(We recommand ScyllaDB as it's better in resource consumption and performances)

## Development

Expand All @@ -64,14 +65,19 @@ At first, get dependencies:
mix deps.get
```

Install the static assets
```
cd assets ; npm install; cd -
```

To start a single node:
```bash
iex -S mix
```

To clean the data from the database
To clean the data
```bash
mix archethic.clean_db
make clean
```

<!-- To start multiple nodes, you can leverage: `docker-compose`
Expand Down

0 comments on commit cb99252

Please sign in to comment.