From 65672c4379924679e8d7f257caa504367c67b498 Mon Sep 17 00:00:00 2001 From: Florian Date: Thu, 28 Mar 2024 21:30:40 +0100 Subject: [PATCH 01/13] Updated README.md --- README.md | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4a87c6b..7e7ff93 100755 --- a/README.md +++ b/README.md @@ -10,6 +10,23 @@ A Gtk application using Rust. The masterpassword/Spectre algorithm is added via - Overall the app is in a usable state. One big missing feature is the option to set the password type. For now all passwords are generated with the password type: long. Short, medium, maximum, ... are not given as an option in the ui. - The flatpak can be build using the rust extension and the `org.gnome.Platform` SDK. Or just downloaded and installed from the github releases section. +## Requirements +It is recommanded to build this app using flatpak builder because with flatpak builder everything listed below is already available. + +If not using flatpak builder the following needs to be installed: +### GTK4 +Install the develepment dependencies for gtk4 and the libadwaita development package. +On fedora run: +``` +sudo dnf install gtk4-devel +sudo dnf install libadwaita-devel +``` + +### The spectre c library +The spectre c lib is using a linked git submodules: run `git submodule update --init --recursive` to download/add the files locally. +### Other requirements +for Bindgen there needs to be clang and libsodium installed see: https://rust-lang.github.io/rust-bindgen/requirements.html +When using Flatpak this should all be available ## Compile Compile with cargo `cargo build` For the flatpak build and installation use: @@ -18,11 +35,6 @@ To only build the flatpak: `./build-aux/flatpak-build.sh` _To uninstall_ `flatpak remove com.github.spectre` -### The spectre c library -The specter c lib is using a linked git submodules: run `git submodule update --init --recursive` to download/add the files locally. -### Other requirements -for Bindgen there needs to be clang and libsodium installed (and maybe llvm devel packages) see: https://rust-lang.github.io/rust-bindgen/requirements.html -When using Flatpak this should all be available ## Screenshots