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

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?

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?)

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?)

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

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 (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.

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..."

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 (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.

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 (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)