Document the extension features

[bilelmoussaoui]

Currently, from vscode, there's no way to know which features the extension brings or which nice to have features are missing. Would be nice if we can document that somewhere in the README.

[Hofer-Julian]

Good point!

Let's prepare something as soon as a few workflows are finalized 😊

[jpercyasnet]

Part of the documentation might include written tutorial like the youtube by baby WOGUE on GTK4, Rust, Flatpak. I am just getting wet with Flatpak and it is not fun. My main purpose is to create GTK4 apps in rust in manjaro and then run them on LinuxMint 20. So like the other enhancement, I need to export it locally so I can bring it over to my older operating system to run. Part of the documentation might be sample Flatpak executes that are generated by each subcommand. I have not figured out how to generate the code after the build, run the sample app or export it outside of visual studio. Thank you for your consideration.

[bilelmoussaoui]

I'm not sure why you thought it was a great idea to ask me about rust or gtk in a completely unrelated repository/issue.

[jpercyasnet]

Sorry. It was how I was introduced to your extension. When you get around to documentation, sample executions scripts (like what is shown in output for most of the subcommands) would be nice. I really appreciate all the programs and articles you have provided. Especially, in regards to GTK4 and Rust.

[bilelmoussaoui]

I'm not sure what you mean by sample executions scripts? Also, have you managed to use the extension or is the black box that's causing you issues and you think needs to be documented a bit more?

[jpercyasnet]

sample executes:
Flatpak init:
flatpak build-init /home/jp/FlatpakArea/gtk-rust-template-master/photoomc03/.flatpak/repo org.jp.photoomc03 org.gnome.Sdk org.gnome.Platform 3.38
Flatpak build dependencies:
flatpak-builder --ccache --force-clean --disable-updates --download-only --state-dir=/home/jp/FlatpakArea/gtk-rust-template-master/photoomc03/.flatpak/flatpak-builder --stop-at=photoomc03 /home/jp/FlatpakArea/gtk-rust-template-master/photoomc03/.flatpak/repo /home/jp/FlatpakArea/gtk-rust-template-master/photoomc03/build-aux/org.jp.photoomc03.json
Flatpak build 1:
flatpak-builder --ccache --force-clean --disable-updates --disable-download --build-only --keep-build-dirs --state-dir=/home/jp/FlatpakArea/gtk-rust-template-master/photoomc03/.flatpak/flatpak-builder --stop-at=photoomc03 /home/jp/FlatpakArea/gtk-rust-template-master/photoomc03/.flatpak/repo /home/jp/FlatpakArea/gtk-rust-template-master/photoomc03/build-aux/org.jp.photoomc03.json
Flatpak built 2:
flatpak build --share=network --nofilesystem=host --filesystem=/home/jp/FlatpakArea/gtk-rust-template-master/photoomc03 --filesystem=/home/jp/FlatpakArea/gtk-rust-template-master/photoomc03/.flatpak/repo --env=PATH=$PATH:/usr/lib/sdk/rust-stable/bin --env=CARGO_HOME=/run/build/photoomc03/cargo --env=RUST_BACKTRACE=1 --env=RUSTFLAGS=-L=/app/lib --filesystem=/home/jp/FlatpakArea/gtk-rust-template-master/photoomc03/_build /home/jp/FlatpakArea/gtk-rust-template-master/photoomc03/.flatpak/repo meson --prefix /app _build -Dprofile=development
Flatpak run? (initial errors with bind-mount but ran after second execute):
flatpak build --with-appdir --allow=devel --bind-mount=/run/user/1000/doc=/run/user/1000/doc/by-app/org.jp.photoomc03.Devel --socket=fallback-x11 --socket=wayland --device=dri --talk-name=org.a11y.Bus --env=RUST_LOG=photoomc03=debug --env=G_MESSAGES_DEBUG=none --talk-name='org.freedesktop.portal.*' --talk-name=org.a11y.Bus --env=COLORTERM=truecolor --env=DESKTOP_SESSION=gnome --env=XDG_SESSION_DESKTOP=gnome --env=XDG_SESSION_TYPE=wayland --env=LANG=en_US.utf8 --env=XDG_CURRENT_DESKTOP=GNOME --env=WAYLAND_DISPLAY=wayland-0 /home/jp/FlatpakArea/gtk-rust-template-master/photoomc03/.flatpak/repo photoomc03

Did not run by its self. Mention ninja version level.

Need Script for RUNNING and also an already requested script for EXPORT-BUNDLE. And maybe documentation on how to take that bundle and use it on another system.

This helps in understanding the process and allow for tweaking some of the parameters.

I am documenting all my efforts in setting up a GTK4 and Rust development environment (Manjaro) and producing products to run on another linux operating system (i.e. Linux Mint 20) using Flatpak and Appimage (need to understand how to add glibc dependencies).

Thank you again for all your efforts.

[bilelmoussaoui]

You need to run update dependencies step before build dependencies.

[jpercyasnet]

I believe my build dependencies is really update dependencies.

[SeaDve]

I think every feature is now documented, and almost on par with Builder features, except #1.