Skip to content

Commit

Permalink
Add readme (#5)
Browse files Browse the repository at this point in the history
  • Loading branch information
MOZGIII authored Nov 11, 2022
1 parent 7d39387 commit a39150f
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
<p align="center">

<img align="center" src="https://logos.humanode.io/humanode-logo.png" style="height: 30vh" alt="Humanode">

</p>

<h1 align="center">Humanode</h1>

<h4 align="center">One human = one node = one vote.</h3>

<p align="center">
<strong>
<a href="https://humanode.io">About</a>&nbsp;&nbsp;&bull;&nbsp;&nbsp;
<a href="https://link.humanode.io/latest-testnet">Testnet</a>&nbsp;&nbsp;&bull;&nbsp;&nbsp;
<a href="https://launcher.humanode.io">Launcher</a>&nbsp;&nbsp;&bull;&nbsp;&nbsp;
<a href="https://link.humanode.io/chat">Chat</a>&nbsp;&nbsp;&bull;&nbsp;&nbsp;
<a href="https://link.humanode.io/chat/troubleshooting">Troubleshooting</a>
</strong>
</p>

## About Humanode

Humanode is an innovative blockchain powered by Human biometrics to achieve Sybil-resistance.

Learn more at [humanode.io](https://humanode.io).

## About Humanode Distribution

Humanode Distribution is a suite of tools to facilitate the installation and setup of the Humanode blockchain node.

### Requirements

- Linux or macOS (no Windows support, sorry!)
- Rust programming language

### Building and running

Use the standard Rust tooling to work on the project: `cargo`!

To build and run the installer cli utility (`humanode-distribution`) use `cargo run`.

Use `cargo run --help` to see cargo options; use `cargo run -- --help` to see `humanode-distribution` options.

### Contribution

1. Fork the repository, clone your fork, create a branch for your changes.
2. Write your code, commit the changes.
3. Create a pull request.
4. Tell us about your new contribution in the [chat](https://link.humanode.io/chat) (optional, but will speed up the process).
5. We will review and give you feedback on the PR; you will have to apply changes to your PR accordingly.
6. Once we are happy with the proposed changes we will merge your code into the main development branch.

Keep in mind we are just starting to accept public contributions, and our internal processes are not polished yet. Give us some slack, expect us to be busy with other stuff most of the time. Although, we will try as hard as we can to provide the feedback on the code asap!

Happy coding!

0 comments on commit a39150f

Please sign in to comment.