Merge pull request #25 from skni-kod/develop

Release version 0.1

.github/workflows/doxygen.yml

@@ -0,0 +1,36 @@
+# This is a basic workflow to help you get started with Actions
+
+name: Doxygen Action
+
+# Controls when the action will run. Triggers the workflow on push or pull request
+# events but only for the develop branch
+on:
+  push:
+    branches: [ develop ]
+
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+    # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+    - uses: actions/checkout@v2
+
+    - name: Doxygen Action
+      uses: mattnotmitt/doxygen-action@v1.1.0
+      with:
+        # Path to Doxyfile
+        doxyfile-path: "./Doxyfile" # default is ./Doxyfile
+        # Working directory
+        working-directory: "." # default is .
+
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./docs/html

Installer/Installer.pro

@@ -0,0 +1,13 @@
+TEMPLATE = aux
+
+INSTALLER = MicrOS DevTools CPP Installer.exe
+
+INPUT = $$PWD/config/config.xml $$PWD/packages
+example.input = INPUT
+example.output = $$INSTALLER
+example.commands = ../../bin/binarycreator --online-only -c $$PWD/config/config.xml -p $$PWD/packages "${QMAKE_FILE_OUT}"
+example.CONFIG += target_predeps no_link combine
+
+QMAKE_EXTRA_COMPILERS += example
+
+OTHER_FILES = README

Installer/README

@@ -0,0 +1,28 @@
+D:\Programy\Qt\Tools\QtInstallerFramework\4.2\bin\binarycreator.exe -c config/config.xml -p packages "MicrOS DevTools CPP Installer.exe"
+
+Shows how to set up an online installer.
+
+The example uses a very simple web server shipped with python.
+
+Generate online repository with
+
+  D:\Programy\Qt\Tools\QtInstallerFramework\4.2\bin\repogen -p packages repository
+
+Generate installer with
+
+  D:\Programy\Qt\Tools\QtInstallerFramework\4.2\bin\binarycreator --online-only -c config/config.xml -p packages Installer.exe
+
+Now launch a minimal web server in the example's directory (admin rights may be needed)
+
+  python -m http.server 80
+
+This should make the content of the local directory available under
+http://localhost
+
+You should be able to now launch the installer.
+
+To deploy an update, run
+
+  D:\Programy\Qt\Tools\QtInstallerFramework\4.2\bin\repogen --update-new-components -p packages_update repository
+
+and launch the maintenance tool in your installation.

Installer/config/Copyright notice.txt

@@ -0,0 +1,7 @@
+DevTools logo
+ - MicrOS cat logo is owned by Studenckie Koło Naukowe Informatyków "KOD" (https://kod.prz.edu.pl/)
+ - Gears are from Google Material Desing Icons https://github.com/google/material-design-icons under Apache-2.0 License
+
+DevTools installer logo
+ - MicrOS cat logo is owned by Studenckie Koło Naukowe Informatyków "KOD" (https://kod.prz.edu.pl/)
+ - Sync icon is from Google Material Desing Icons https://github.com/google/material-design-icons under Apache-2.0 License

Installer/config/config.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Installer>
+    <Name>MicrOS DevTools CPP</Name>
+    <Version>0.1</Version>
+    <Title>MicrOS DevTools CPP</Title>
+    <Publisher>Studenckie Koło Naukowe Informatyków "KOD"</Publisher>
+    <ProductUrl>https://kod.prz.edu.pl/project/25</ProductUrl>
+    <StartMenuDir>MicrOS DevTools CPP</StartMenuDir>
+    <TargetDir>@RootDir@/Programy/MicrOSDevToolsCPP</TargetDir>
+    <AllowNonAsciiCharacters>true</AllowNonAsciiCharacters>
+    <MaintenanceToolName>Instalator</MaintenanceToolName>
+    <InstallActionColumnVisible>true</InstallActionColumnVisible>
+    <InstallerApplicationIcon>DevTools Installer icon</InstallerApplicationIcon>
+    <InstallerWindowIcon>DevTools Installer icon.png</InstallerWindowIcon>
+    <Logo>DevTools Installer banner.png</Logo>
+    <WizardStyle>Modern</WizardStyle>
+    <RemoteRepositories>
+        <Repository>
+            <Url>https://kod.prz.edu.pl/repository/micros_devtools_cpp/program/</Url>
+        </Repository>
+    </RemoteRepositories>
+</Installer>

Installer/packages/documentationmicros/meta/installscript.qs

@@ -0,0 +1,17 @@
+function Component()
+{
+
+}
+
+Component.prototype.createOperations = function()
+{
+    component.createOperations();
+
+    if (systemInfo.productType === "windows")
+    {
+        // Main icons
+        component.addOperation("CreateShortcut", "@TargetDir@/Documentation/DokumentacjaMicrOSa.pdf",
+            "@StartMenuDir@/Dokumentacja/Dokumentacja MicrOSa.lnk");
+    }
+}
+

Installer/packages/documentationmicros/meta/package.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Package>
+    <DisplayName>Dokumentacja systemu MicrOS</DisplayName>
+    <Description>Dokumentacja systemu operacyjnego MicrOS.</Description>
+    <Version>1.0</Version>
+    <ReleaseDate>2022-02-20</ReleaseDate>
+    <SortingPriority>50</SortingPriority>
+    <Default>true</Default>
+    <Script>installscript.qs</Script>
+</Package>

Installer/packages/documentationmicrosdevtoolscpp/meta/installscript.qs

@@ -0,0 +1,17 @@
+function Component()
+{
+
+}
+
+Component.prototype.createOperations = function()
+{
+    component.createOperations();
+
+    if (systemInfo.productType === "windows")
+    {
+        // Main icons
+        component.addOperation("CreateShortcut", "@TargetDir@/Documentation/DokumentacjaMicrOSDevToolsCPP.pdf",
+            "@StartMenuDir@/Dokumentacja/Dokumentacja MicrOS DevTools CPP.lnk");
+    }
+}
+

Installer/packages/documentationmicrosdevtoolscpp/meta/package.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Package>
+    <DisplayName>Dokumentacja MicrOS DevTools CPP</DisplayName>
+    <Description>Dokumentacja narzędzia MicrOS DevTools CPP.</Description>
+    <Version>0.1</Version>
+    <ReleaseDate>2022-02-20</ReleaseDate>
+    <SortingPriority>75</SortingPriority>
+    <Default>true</Default>
+    <Script>installscript.qs</Script>
+</Package>

Installer/packages/microsdevtoolscpp.links/data/Links/ClubSite.url

@@ -0,0 +1,5 @@
+[{000214A0-0000-0000-C000-000000000046}]
+Prop3=19,11
+[InternetShortcut]
+URL=https://kod.prz.edu.pl/
+IDList=

Installer/packages/microsdevtoolscpp.links/data/Links/DocumentationGitHub.url

@@ -0,0 +1,5 @@
+[{000214A0-0000-0000-C000-000000000046}]
+Prop3=19,11
+[InternetShortcut]
+URL=https://github.com/skni-kod/MicrOS-DevTools-CPP-Dokumentacja
+IDList=

Installer/packages/microsdevtoolscpp.links/data/Links/MicrOSDocumentationGitHub.url

@@ -0,0 +1,5 @@
+[{000214A0-0000-0000-C000-000000000046}]
+Prop3=19,11
+[InternetShortcut]
+URL=https://github.com/skni-kod/MicrOSa-Dokumentacja
+IDList=

Installer/packages/microsdevtoolscpp.links/data/Links/MicrOSGitHub.url

@@ -0,0 +1,5 @@
+[{000214A0-0000-0000-C000-000000000046}]
+Prop3=19,11
+[InternetShortcut]
+URL=https://github.com/skni-kod/MicrOS
+IDList=

Installer/packages/microsdevtoolscpp.links/data/Links/ProjectDoxygen.url

@@ -0,0 +1,5 @@
+[{000214A0-0000-0000-C000-000000000046}]
+Prop3=19,11
+[InternetShortcut]
+URL=https://skni-kod.github.io/MicrOS-DevTools-CPP/
+IDList=

Installer/packages/microsdevtoolscpp.links/data/Links/ProjectGitHub.url

@@ -0,0 +1,6 @@
+[{000214A0-0000-0000-C000-000000000046}]
+Prop3=19,11
+[InternetShortcut]
+URL=https://github.com/skni-kod/MicrOS-DevTools-CPP
+IDList=
+HotKey=0

Installer/packages/microsdevtoolscpp.links/data/Links/ProjectSite.url

@@ -0,0 +1,5 @@
+[{000214A0-0000-0000-C000-000000000046}]
+Prop3=19,11
+[InternetShortcut]
+URL=https://kod.prz.edu.pl/project/25
+IDList=

Installer/packages/microsdevtoolscpp.links/data/Links/ProjektMicrOSSite.url

@@ -0,0 +1,5 @@
+[{000214A0-0000-0000-C000-000000000046}]
+Prop3=19,11
+[InternetShortcut]
+URL=https://kod.prz.edu.pl/project/1
+IDList=

Installer/packages/microsdevtoolscpp.links/meta/installscript.qs

@@ -0,0 +1,36 @@
+function Controller()
+{
+
+}
+
+function Component()
+{
+
+}
+
+Component.prototype.createOperations = function()
+{
+    component.createOperations();
+
+    if (systemInfo.productType === "windows")
+    {
+        // Urls
+        component.addOperation("Mkdir", "@StartMenuDir@/Linki");
+        component.addOperation("Copy", "@TargetDir@/Links/ClubSite.url",
+            "@StartMenuDir@/Linki/Strona koła.url");
+        component.addOperation("Copy", "@TargetDir@/Links/DocumentationGitHub.url",
+            "@StartMenuDir@/Linki/GitHub dokumentacji MicrOS DevTools CPP.url");
+        component.addOperation("Copy", "@TargetDir@/Links/MicrOSDocumentationGitHub.url",
+            "@StartMenuDir@/Linki/GitHub dokumentacji MicrOSa.url");
+        component.addOperation("Copy", "@TargetDir@/Links/MicrOSGitHub.url",
+            "@StartMenuDir@/Linki/GitHub MicrOSa.url");
+        component.addOperation("Copy", "@TargetDir@/Links/ProjectDoxygen.url",
+            "@StartMenuDir@/Linki/Doxygen projektu MicrOS DevTools CPP.url");
+        component.addOperation("Copy", "@TargetDir@/Links/ProjectGitHub.url",
+            "@StartMenuDir@/Linki/GitHub MicrOS DevTools CPP.url");
+        component.addOperation("Copy", "@TargetDir@/Links/ProjectSite.url",
+            "@StartMenuDir@/Linki/Strona projektu MicrOS DevTools CPP.url");
+        component.addOperation("Copy", "@TargetDir@/Links/ProjektMicrOSSite.url",
+            "@StartMenuDir@/Linki/Strona projektu MicrOS.url");
+    }
+}

Installer/packages/microsdevtoolscpp.links/meta/package.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Package>
+    <DisplayName>Linki</DisplayName>
+    <Description>Przydatne linki do strony koła, githuba, dokumentacji oraz innych stron.</Description>
+    <Version>1.0</Version>
+    <ReleaseDate>2022-02-20</ReleaseDate>
+    <SortingPriority>95</SortingPriority>
+    <Default>true</Default>
+    <Script>installscript.qs</Script>
+</Package>

Installer/packages/microsdevtoolscpp/data/MicrOSDevToolsCPP/ReadMe.txt

@@ -0,0 +1,5 @@
+# MicrOS-DevTools-CPP
+ MicrOS DevTools CPP is succesor of MicrOS DevTools for MicrOS developers.
+
+## Functions
+Program in version 0.1 describes what tools you'll need to develop MicrOS, provider useful links and documentation.

Installer/packages/microsdevtoolscpp/meta/finishcheckboxform.ui

@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>FinishCheckBoxForm</class>
+ <widget class="QWidget" name="FinishCheckBoxForm">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>412</width>
+    <height>179</height>
+   </rect>
+  </property>
+  <layout class="QVBoxLayout" name="verticalLayout">
+   <property name="margin">
+    <number>0</number>
+   </property>
+   <item>
+    <widget class="QCheckBox" name="readMeCheckBox">
+     <property name="text">
+      <string>Otwórz ReadMe</string>
+     </property>
+     <property name="checked">
+      <bool>true</bool>
+     </property>
+     <property name="tristate">
+      <bool>false</bool>
+     </property>
+    </widget>
+   </item>
+  </layout>
+ </widget>
+ <resources/>
+ <connections/>
+</ui>

Installer/packages/microsdevtoolscpp/meta/installscript.qs

@@ -0,0 +1,83 @@
+function Controller()
+{
+
+}
+
+function Component()
+{
+    // For checkbox to show "Open ReadMe"
+    installer.installationFinished.connect(this, Component.prototype.installationFinishedPageIsShown);
+    installer.finishButtonClicked.connect(this, Component.prototype.installationFinished);
+
+    // For changing information on target directory page
+    if (!installer.isCommandLineInstance())
+    {
+        page = gui.pageWidgetByObjectName("TargetDirectoryPage");
+        if(page !== null)
+        {
+            page.entered.connect(changeTargetDirectoryLabels);
+        }
+    }
+}
+
+changeTargetDirectoryLabels = function()
+{
+    page = gui.pageWidgetByObjectName("TargetDirectoryPage");
+    page.MessageLabel.setText("Podaj katalog, w którym ma zostać zainstalowany element MicrOS DevTools CPP."+
+    "\n" + "Jeśli instalujesz ten program z konta zwykłego użytkownika nie rób tego w folderze chronionym np. Program Files." +
+    "\n" + "Spowoduje to problem z dostępem do folderu, gdzie instalator spróbuje przechować tymczasowe pliki instalacyjne. Szczegółowe informacje w dokumentacji.");
+}
+
+Component.prototype.createOperations = function()
+{
+    component.createOperations();
+
+    if (systemInfo.productType === "windows")
+    {
+        // Desktop
+        component.addOperation("CreateShortcut", "@TargetDir@/MicrOSDevToolsCPP/MicrOSDevToolsCPP.exe", "@DesktopDir@/MicrOS DevTools CPP.lnk");
+
+        // Main icons
+        component.addOperation("CreateShortcut", "@TargetDir@/MicrOSDevToolsCPP/MicrOSDevToolsCPP.exe", "@StartMenuDir@/MicrOS DevTools CPP.lnk");
+        component.addOperation("CreateShortcut", "@TargetDir@/Instalator.exe", "@StartMenuDir@/Instalator.lnk");
+        component.addOperation("CreateShortcut", "@TargetDir@/MicrOSDevToolsCPP/ReadMe.txt", "@StartMenuDir@/ReadMe.lnk");
+
+        // Licenses
+        component.addOperation("CreateShortcut", "@TargetDir@/Licenses/licencja-micros-devtools-cpp.txt",
+            "@StartMenuDir@/Licencje/Licencja MicrOS DevTools CPP.lnk");
+        component.addOperation("CreateShortcut", "@TargetDir@/Licenses/licencja-openssl-ssleay.txt",
+            "@StartMenuDir@/Licencje/Licencja OpenSSL.lnk");
+    }
+}
+
+Component.prototype.installationFinishedPageIsShown = function()
+{
+    try
+    {
+        if (installer.isInstaller() && installer.status == QInstaller.Success)
+        {
+            installer.addWizardPageItem( component, "FinishCheckBoxForm", QInstaller.InstallationFinished );
+        }
+    } catch(e)
+    {
+        console.log(e);
+    }
+}
+
+Component.prototype.installationFinished = function()
+{
+    try
+    {
+        if (installer.isInstaller() && installer.status == QInstaller.Success)
+        {
+            var checkboxForm = component.userInterface( "FinishCheckBoxForm" );
+            if (checkboxForm && checkboxForm.readMeCheckBox.checked)
+            {
+                QDesktopServices.openUrl("file:///" + installer.value("TargetDir") + "/MicrOSDevToolsCPP/ReadMe.txt");
+            }
+        }
+    } catch(e)
+    {
+        console.log(e);
+    }
+}