Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve installation instructions #83

Merged
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

Neptune-core is the reference implementation for the [Neptune](https://neptune.cash/) protocol. The implementation is not complete yet, but already supports many integral components. In particular, alpha-net is live.

## Compiling from Source
## Installing

### Linux Debian/Ubuntu
### Compile from Source -- Linux Debian/Ubuntu

- Install curl: `apt install curl`
- Install the rust compiler and accessories: `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`
- Source the rust environment: `source $HOME/.cargo/env`
- Install LebelDB: `apt install libleveldb-dev libsnappy-dev cmake`
- Install curl: `apt install curl` (as root)
aszepieniec marked this conversation as resolved.
Show resolved Hide resolved
- Install the rust compiler and accessories: `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y`
- Source the rust environment: `source "$HOME/.cargo/env"`
- Install LebelDB: `apt install libleveldb-dev libsnappy-dev cmake` (as root)
aszepieniec marked this conversation as resolved.
Show resolved Hide resolved
- Download the repository: `git clone https://github.com/Neptune-Crypto/neptune-core.git`
- Enter the repository: `cd neptune-core`
- Build for release and put the binaries in your local path (`~/.cargo/bin/`): `cargo install --path .` (needs at least 3 GB of RAM)
- Build for release and put the binaries in your local path (`~/.cargo/bin/`): `cargo install --path .` (needs at least 3 GB of RAM and a minute or two)
aszepieniec marked this conversation as resolved.
Show resolved Hide resolved

## Running & Connecting

Expand Down
Loading