From c5bbf1b772261fe022bbb39309484f51f335a550 Mon Sep 17 00:00:00 2001 From: Revertron Date: Tue, 16 Feb 2021 23:27:25 +0100 Subject: [PATCH] Updated README with steps to build Alfis. --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index d1d7461..65d3bc6 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,31 @@ Alternative Free Identity System This project represents a minimal blockchain with no coin, capable of sustaining any number of domain name zones and domains. + + +## Building + +### On every OS +You can build Alfis by issuing `cargo build` and `cargo run` commands in a directory of cloned repository. +If you want to build release version you need to do `cargo build --release` as usual. + +### On Windows +You don't need any additional steps to build Alfis, just stick to the MSVC version of Rust. + +### On Windows (MINGW64) +If you'd rather use Gnu version of Rust you can build Alfis by these steps: +``` +pacman -S git +pacman -Ss rust +pacman -S mingw64/mingw-w64-x86_64-rust +pacman -Ss cargo +pacman -S mingw64/mingw-w64-x86_64-cargo-c +git clone https://github.com/Revertron/Alfis.git +cd Alfis +cargo build +cargo run +``` + +### On Linux +If you are building on Linux you must ensure that you have `libwebkitgtk` library installed. +You can do it by issuing this command: `sudo apt install libwebkit2gtk-4.0-dev` (on Debian/Ubuntu and derivatives). \ No newline at end of file