updated readme, hbs2 install section

This commit is contained in:
Dmitry Zuikov 2023-03-25 10:13:42 +03:00
parent 10bde0a539
commit fc05cbf152
1 changed files with 17 additions and 0 deletions

View File

@ -1,6 +1,7 @@
- [ABOUT](#about) - [ABOUT](#about)
- [What is it](#what-is-it) - [What is it](#what-is-it)
- [HOWTO](#howto) - [HOWTO](#howto)
- [How to install](#how-to-install)
- [How to run hbs2-peer](#how-to-run-hbs2-peer) - [How to run hbs2-peer](#how-to-run-hbs2-peer)
- [How to configure hbs2-peer](#how-to-configure-hbs2-peer) - [How to configure hbs2-peer](#how-to-configure-hbs2-peer)
- [How to make a pull request](#how-to-make-a-pull-request) - [How to make a pull request](#how-to-make-a-pull-request)
@ -75,6 +76,22 @@ stability issues. We\'re working hard to fix them.
# HOWTO # HOWTO
## How to install
Assuming you know what the Nix and Nix flakes are
(nixog.org)
and nix flake support is turned on on your system:
```
nix profile install github:voidlizard/hbs2/master
```
It will take time. Patience, we're working on rolling
out cachix, that will allow binary caches for the
project.
## How to run hbs2-peer ## How to run hbs2-peer
hbs2-peer run \[-c config\] hbs2-peer run \[-c config\]