Topic: Rework of documentation to build Qelectrotech from source

Hello everyone, I'm currently reworking adding infos to build Qelectrotech.

I'm in the process of creating a BUILD.md file to help contributors to get started.

Do you got any tips about building the app (dependencies to install, tools like QT creator to configure, etc..) that you want to share?

if you got any, do not hesitate to add a message to this subject. Linux build options would be appreciated as this is my main OS.

Thx in advance

  • scorpio810
  • scorpio810
  • QElectroTech Team Manager, Developer, Packager
  • Offline

Re: Rework of documentation to build Qelectrotech from source

Hello,
Old documentation for Qt creator
https://qelectrotech.org/wiki_new/doc/qt_creator

My old note for debian packaging: https://qelectrotech.org/wiki_new/doc/packaging_debian

https://github.com/qelectrotech/qelectr … ppImage.sh
https://github.com/qelectrotech/qelectr … Windows.sh
https://github.com/qelectrotech/qelectr … Flatpak.sh

https://github.com/qelectrotech/qelectr … y_arm64.sh

"Le jour où tu découvres le Libre, tu sais que tu ne pourras jamais plus revenir en arrière..."

Re: Rework of documentation to build Qelectrotech from source

scorpio810 wrote:

Hello,
Old documentation for Qt creator
https://qelectrotech.org/wiki_new/doc/qt_creator

1) In the old doc for QT, I see that a xml coding style is mentionned, is it still used?

2) Could you please describe me the QTCreator in all of its details please?

  • scorpio810
  • scorpio810
  • QElectroTech Team Manager, Developer, Packager
  • Offline

Re: Rework of documentation to build Qelectrotech from source

I think this readme can help you.
1) Yes.
https://github.com/qelectrotech/qelectr … IBUTING.md

"Le jour où tu découvres le Libre, tu sais que tu ne pourras jamais plus revenir en arrière..."

Re: Rework of documentation to build Qelectrotech from source

Since the wiki looks... very out of date, would it be unreasonable that I bundle the code style in the mirror source code? (I'm getting the impression that a repo for the wiki would be necessary to easily edit/keep track off/update the informations, would you be against it?)

  • scorpio810
  • scorpio810
  • QElectroTech Team Manager, Developer, Packager
  • Offline

Re: Rework of documentation to build Qelectrotech from source

Yes you can, see
https://github.com/qelectrotech/qelectr … irror/wiki

git clone https://github.com/qelectrotech/qelectrotech-source-mirror.wiki.git

Edit: If you're interested, I can give you writing rights to the dokuwiki, if you want?

"Le jour où tu découvres le Libre, tu sais que tu ne pourras jamais plus revenir en arrière..."

Re: Rework of documentation to build Qelectrotech from source

Could be a good idea, what I had in mind was to get the content of the docuwiki, put it in markdown in a github and find a way to publish the contents online (maybe a bookstack) as the markdown + git approach would make it easier to update things.

Au fait pour les prochaines discussions, pas besoin de rester en anglais, je viens de voir sur le forum que toi aussi tu est français, on va faire plaisir à l'académie nationale en perfectionnant notre grammaire.

Blague à part, sur les fichiers que tu m'a envoyé, je ne vois pas grand chose à propos de linux (malgré le fait que tu utilise mingw, est ce que ca diffère un peu sous linux?)

  • scorpio810
  • scorpio810
  • QElectroTech Team Manager, Developer, Packager
  • Offline

Re: Rework of documentation to build Qelectrotech from source

En principe sous une Debian like il suffit de cloner le git

git clone --recursive https://github.com/qelectrotech/qelectrotech-source-mirror.git

D'installer ces dépendances:

               libqt5svg5-dev,
               qt5-qmake,
               qtbase5-dev,
               libkf5widgetsaddons-dev,
               libkf5coreaddons-dev, 
               libsqlite3-dev,
               pkgconf

Ensuite dans Qt creator ouvrir projet, puis rechercher et sélectionner le fichier qelectrotech.pro dans le dossier récupéré lors du git clone.

Si l'on veut juste compiler la dernière version dans un terminal sans passer par Qt creator:

git clone --recursive https://github.com/qelectrotech/qelectrotech-source-mirror.git
cd qelectrotech-source-mirror.git
mkdir build && cd build
qmake  ../qelectrotech.pro
make -j$(nproc)

https://qelectrotech.org/forum/viewtopi … 702#p19702
https://qelectrotech.org/forum/viewtopic.php?id=2313

Pour l'emplacement des collections, on peux maintenant choisir leurs emplacements à la volée dans le menu configurer QElectroTech depuis le logiciel, ce qui évite de rajouter les arguments de l’exécutable dans Qt creator.

Cordialement,
Laurent

"Le jour où tu découvres le Libre, tu sais que tu ne pourras jamais plus revenir en arrière..."

Re: Rework of documentation to build Qelectrotech from source

Merci,
Écoute je vais expérimenter un peu sur mon github perso et si jamais sa t'intéresse tu pourra cloner le repo.

Bonne soirée

  • scorpio810
  • scorpio810
  • QElectroTech Team Manager, Developer, Packager
  • Offline

Re: Rework of documentation to build Qelectrotech from source

Merci,
bonne soirée a toi aussi.

"Le jour où tu découvres le Libre, tu sais que tu ne pourras jamais plus revenir en arrière..."

11 Reply by Integrated-Circuit (edited by Integrated-Circuit 2024-07-14 13:57:50)

Re: Rework of documentation to build Qelectrotech from source

j'ai commencé à créer un site wiki https://github.com/Integrat-edCircuit/Qelectrotech-wiki basé sur l'outil sphinx. l'avantage est que celui-ci utilise les fichiers au format .rst (assez facile a modif lorsq'on connait la syntaxe) et que je l'ai configuré d'une facon à avoir un makefile qui build automatiquement les fichiers html, je suis en train de set up l'action github pour avoir un build continuel. j'ai juste un peu de mal avec la fonction d'upload des artifacts de build de github. si quelqu’un si connait je suis preneur.

On pourrait imaginer que dans le futur on pourrai bundle les fichiers HTML et avoir à la fois un manuel on- et off-line pour les utilisateurs de QET.

  • scorpio810
  • scorpio810
  • QElectroTech Team Manager, Developer, Packager
  • Offline

Re: Rework of documentation to build Qelectrotech from source

Çà ressemble à ce que je fait avec Doxygen ici: https://download.qelectrotech.org/qet/doxygen/html/

"Le jour où tu découvres le Libre, tu sais que tu ne pourras jamais plus revenir en arrière..."
  • scorpio810
  • scorpio810
  • QElectroTech Team Manager, Developer, Packager
  • Offline

Re: Rework of documentation to build Qelectrotech from source

En parlant de sphinx, dommage qu'il n'y ai plus de contributeur sur la documentation:
https://github.com/qelectrotech/qelectrotech-doc

"Le jour où tu découvres le Libre, tu sais que tu ne pourras jamais plus revenir en arrière..."

14 Reply by Integrated-Circuit (edited by Integrated-Circuit 2024-07-14 14:35:20)

Re: Rework of documentation to build Qelectrotech from source

C'est exactement ce que je suis en train de faire...
Possible d'être contributeur?

Au pire, attend je suis en train de refaire pas mal de choses. je peux récupérer des contenus et lorsque ce sera bon:

1. tu clone mon repo et tu l'utilise comme manuel pour QET
et
2. on conserve l'ancien pour de l'archivage

Re: Rework of documentation to build Qelectrotech from source

scorpio810 wrote:

En parlant de sphinx, dommage qu'il n'y ai plus de contributeur sur la documentation:
https://github.com/qelectrotech/qelectrotech-doc

En parlant de la doc, vous la hostez où? parce que j'ai commencé à créer un script CI github et je suis en train de mettre en place le hostiong avec les pages github, mais si vous l'hostez autre part, ca sert a rien que j'implémente ca.

  • scorpio810
  • scorpio810
  • QElectroTech Team Manager, Developer, Packager
  • Offline

Re: Rework of documentation to build Qelectrotech from source

Salut,
le wiki est sur un serveur, après le code etc, est sur github.
En parlant de CI, si tu connais ça m’intéressais bien de ne plus avoir avoir a faire de mon coté toutes les builds et packages (Debian deb, stable sid, Windows installer, readyToUse, flatpak,AppImage, Apple Intel)sur ma machine après chaque gros commits, de 1 ça exige une grosse machine qui coûte une fortune à l'achat et qui est dépassé 4 apres.. et de 2 elle consomme beaucoup de courant Lmême en idle..(180W) et plus de 500W en compile 48 Thread..
les factures qui augmentent .. ne font que réduire mon petit budget.. et suite à mes gros problemes de santé mon salaire à bien diminué..

"Le jour où tu découvres le Libre, tu sais que tu ne pourras jamais plus revenir en arrière..."

17 Reply by Integrated-Circuit (edited by Integrated-Circuit 2024-07-17 21:20:16)

Re: Rework of documentation to build Qelectrotech from source

scorpio810 wrote:

Salut,
le wiki est sur un serveur, après le code etc, est sur github.
En parlant de CI, si tu connais ça m’intéressais bien de ne plus avoir avoir a faire de mon coté toutes les builds et packages (Debian deb, stable sid, Windows installer, readyToUse, flatpak,AppImage, Apple Intel)sur ma machine après chaque gros commits, de 1 ça exige une grosse machine qui coûte une fortune à l'achat et qui est dépassé 4 apres.. et de 2 elle consomme beaucoup de courant Lmême en idle..(180W) et plus de 500W en compile 48 Thread..
les factures qui augmentent .. ne font que réduire mon petit budget.. et suite à mes gros problemes de santé mon salaire à bien diminué..

Faut que je regarde, mais oui ce serait bien (on pourrait imaginer une CI qui build QET et pull le master du manuel lors de la compilation)

Re: Rework of documentation to build Qelectrotech from source

scorpio810 wrote:

Salut,
le wiki est sur un serveur, après le code etc, est sur github.
En parlant de CI, si tu connais ça m’intéressais bien de ne plus avoir avoir a faire de mon coté toutes les builds et packages (Debian deb, stable sid, Windows installer, readyToUse, flatpak,AppImage, Apple Intel)sur ma machine après chaque gros commits, de 1 ça exige une grosse machine qui coûte une fortune à l'achat et qui est dépassé 4 apres.. et de 2 elle consomme beaucoup de courant Lmême en idle..(180W) et plus de 500W en compile 48 Thread..
les factures qui augmentent .. ne font que réduire mon petit budget.. et suite à mes gros problemes de santé mon salaire à bien diminué..

Au fait , j'ai pensé à un truc pour mettre en plance une CI du site avec envoi sur le serv du manuel.
Sachant qu'il est host sur une machine séparée de Github, il serai possible d'ajouter une étape d'upload des fichiers html à la CI.
On pouurait alors utiliser rclone ou scp/sftp pour effectuer le transfert de Github vers le serv.
je peux préparer le terrain, comme ca tu pourras faire après ma MR un commit incluant une clé SSH obfusquée pointant vers le serv.

Vois le dessin que j'ai fais si tu comprend pas bien se que je dis

Post's attachments

Attachment icon Sans titre.png 178.52 kb, 5 downloads since 2024-07-22 

  • scorpio810
  • scorpio810
  • QElectroTech Team Manager, Developer, Packager
  • Offline

Re: Rework of documentation to build Qelectrotech from source

Vu qu'on a changé d’hébergeur, autant c'était facile avec le panel de VHFS de TuxFamily à l’époque de donner des droits de lecture/écriture en fonction de l'user et des répertoires, c'est bien plus compliqué sur le nouvel hébergement.
Voir: https://qelectrotech.org/forum/viewtopic.php?id=2533

Donc je préfère qu'on fasse tout par Github et créer des pages HTML Github.
Ça m’évite beaucoup de travail, créer un token sur le CI de gérer le rsync Github-> site, etc.
En ce moment je n'ai pas trop le temps, pb de santé et reprise du taff après x mois d’arrêt c'est compliqué pour moi et mon corps..

Apres sur le site c'est juste un lien à changer sur quelques entités, forum, main site, ect. qui pointeront vers les nouvelles pages HTML Github au lieu du site.

"Le jour où tu découvres le Libre, tu sais que tu ne pourras jamais plus revenir en arrière..."

Re: Rework of documentation to build Qelectrotech from source

scorpio810 wrote:

Vu qu'on a changé d’hébergeur, autant c'était facile avec le panel de VHFS de TuxFamily à l’époque de donner des droits de lecture/écriture en fonction de l'user et des répertoires, c'est bien plus compliqué sur le nouvel hébergement.

Donc je préfère qu'on fasse tout par Github et créer des pages HTML Github.
Ça m’évite beaucoup de travail, créer un token sur le CI de gérer le rsync Github-> site, etc.
Apres sur le site c'est juste un lien à changer sur quelques entités, forum, main site, ect. qui pointeront vers les nouvelles pages HTML Github au lieu du site.

OK pas de problème, je pense que je vois le délire que serait ma proposition.

Petite question, tu dispose des droits sur le domaine qelectrotech.org non (ajouter un sous-domaine, etc...)? parce que Github peut te permettre de mettre un domaine custom. On pourrait imaginer un truc du style "manual.qeletrotech.org".

Re: Rework of documentation to build Qelectrotech from source

Au fait, pour l'instant la Direction que ca prend sa te semble bon? ou je dois procéder à des changements?

  • scorpio810
  • scorpio810
  • QElectroTech Team Manager, Developer, Packager
  • Offline

Re: Rework of documentation to build Qelectrotech from source

Integrated-Circuit wrote:

Au fait, pour l'instant la Direction que ca prend sa te semble bon? ou je dois procéder à des changements?

Désolé, j'ai juste regardé tes commits, mais pas testé en local ce que ça donnait.

"Le jour où tu découvres le Libre, tu sais que tu ne pourras jamais plus revenir en arrière..."

Re: Rework of documentation to build Qelectrotech from source

Re, ca fait un bail.

Le projet est de plus en plus ambitieux et complexe. Je pense intégrer les éléments du wiki dans la doc d'une façon ou d'une autre.

Cela centraliserai toutes les infos au même endroit, ce qui rendrait peut-être le wiki obsolète.

Est ce que ca te dérange?

  • scorpio810
  • scorpio810
  • QElectroTech Team Manager, Developer, Packager
  • Offline

Re: Rework of documentation to build Qelectrotech from source

Integrated-Circuit wrote:

Re, ca fait un bail.

Le projet est de plus en plus ambitieux et complexe. Je pense intégrer les éléments du wiki dans la doc d'une façon ou d'une autre.

Cela centraliserai toutes les infos au même endroit, ce qui rendrait peut-être le wiki obsolète.

Est ce que ca te dérange?

Çà ne me dérange pas.
Une page Github html ou l'on peut voir le résultat, et éventuellement faire des corrections, améliorations ?

"Le jour où tu découvres le Libre, tu sais que tu ne pourras jamais plus revenir en arrière..."

Re: Rework of documentation to build Qelectrotech from source

scorpio810 wrote:
Integrated-Circuit wrote:

Re, ca fait un bail.

Le projet est de plus en plus ambitieux et complexe. Je pense intégrer les éléments du wiki dans la doc d'une façon ou d'une autre.

Cela centraliserai toutes les infos au même endroit, ce qui rendrait peut-être le wiki obsolète.

Est ce que ca te dérange?

Çà ne me dérange pas.
Une page Github html ou l'on peut voir le résultat, et éventuellement faire des corrections, améliorations ?

Ca fonctionnerait sur le même principe que la doc, ajouter /modifier le fichier .rst et le build lors des commits et pulls request.

Cela dit en passant, j'ai regardé les logs de modif' du wiki et au vu de leur faible quantité, je pense que l'on peut demander aux gens de créer un ticket sur le repo de la doc en cas de problème.


A propos, sur un tout autre sujet, je suis en ce moment chez SEW Usocome pour un job d'été et la maintenance à besoin d'un logiciel pour du pneumatique. je tente de pousser l'utilisation de Qet nomicons/wink