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

Latest commit

 

History

History
57 lines (38 loc) · 3.2 KB

README.md

File metadata and controls

57 lines (38 loc) · 3.2 KB
Raw

Holochain Rust Conductor

Project PM Chat

This crate implements a reference Conductor for serving Holochain DNAs.

Install

Our recommended pattern for the installation of the conductor is to download the binary for your platform from our releases page. Otherwise, you can proceed with the more complex instructions for building from source, below.

Building From Source

These dependencies need to be installed in order to compile, and use holochain:

  • Rust
    • needs to be the nightly-2019-01-24 build, so use the following commands, once you have first installed Rust
    • rustup toolchain install nightly-2019-01-24
    • rustup default nightly-2019-01-24
    • Also, if you are going to be developing Zomes in Rust, install the WASM build target for Rust, by running:
    • rustup target add wasm32-unknown-unknown --toolchain nightly-2019-01-24

To install the cutting edge version of the Holochain conductor, run the following command in a terminal

$ cargo install holochain --force --git https://github.com/holochain/holochain-rust.git --branch develop

To install the latest released version of the Holochain conductor, run the following command in a terminal

$ cargo install holochain --force --git https://github.com/holochain/holochain-rust.git --tag v0.0.18-alpha1

The Conductor should then be available from your command line using the holochain command.

Run holochain --version to confirm that it built.

Usage

To learn about holochain and how to use it, check out the chapter in the guidebook all about it.

https://developer.holochain.org/guide/latest/production_conductor.html

Contribute

Holochain is an open source project. We welcome all sorts of participation and are actively working on increasing surface area to accept it. Please see our contributing guidelines for our general practices and protocols on participating in the community.

License

License: GPL v3

Copyright (C) 2018, Holochain Foundation

This program is free software: you can redistribute it and/or modify it under the terms of the license p rovided in the LICENSE file (GPLv3). This program is distributed in the hope that it will be useful, bu t WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Note: We are considering other 'looser' licensing options (like MIT license) but at this stage are using GPL while we're getting the matter sorted out. See this article for some of our thinking on licensing for distributed application frameworks.