|
8 | 8 | [](https://sonarcloud.io/summary/new_code?id=przemek83_volbx) |
9 | 9 | [](https://sonarcloud.io/summary/new_code?id=przemek83_volbx) |
10 | 10 |
|
11 | | -## Table of content |
| 11 | +## Table of contents |
12 | 12 | - [Example view](#example-view) |
13 | | -- [Description](#description) |
14 | | -- [History](#history) |
15 | | -- [Used tools and libs](#used-tools-and-libs) |
16 | | -- [Compilation and installation](#Compilation-and-installation) |
17 | | -- [Licensing](#licensing) |
| 13 | +- [About project](#about-project) |
| 14 | +- [Getting Started](#getting-started) |
| 15 | + * [Prerequisites](#prerequisites) |
| 16 | + * [Building](#building) |
| 17 | +- [Built with](#built-with) |
18 | 18 | - [Updater](#updater) |
19 | 19 | - [Setup update server](#setup-update-server) |
20 | 20 | - [Testing](#testing) |
| 21 | +- [Licensing](#licensing) |
21 | 22 | - [Potential further improvements](#potential-further-improvements) |
22 | 23 | - [Screenshots](#screenshots) |
23 | 24 |
|
@@ -66,13 +67,6 @@ As a result of compilation, binary for simulations and binary for testing should |
66 | 67 | | Wble | 1.2.0 | 1.2.0 | 1.2.0 | |
67 | 68 | | QuaZip | 1.4 | 1.4 | 1.4 | |
68 | 69 |
|
69 | | -## Licensing |
70 | | -Volbx is published using LGPLv3 license. |
71 | | - |
72 | | -The project uses the following software and licenses: |
73 | | -* Qt, Qwt, QuaZip, Eible, Wble and Qwtble libraries - LGPL licenses (more on qt-project.org, quazip.sourceforge.net, qwt.sourceforge.net and github.com/przemek83), |
74 | | -* Zlib - Zlib license (can be found on zlib.net). |
75 | | - |
76 | 70 | ## Updater |
77 | 71 | 1) Build target `VersionCheck`. |
78 | 72 | 2) Run `VersionCheck`. |
@@ -149,6 +143,19 @@ Total Test time (real) = 0.39 sec |
149 | 143 |
|
150 | 144 | ``` |
151 | 145 |
|
| 146 | +## Licensing |
| 147 | +Volbx is published under a LGPL license. |
| 148 | + |
| 149 | +The project uses the following software: |
| 150 | +| Name | License | Home | Description | |
| 151 | +| --- | --- | --- | --- | |
| 152 | +| Qt | LGPLv3 | https://www.qt.io/| cross-platform application development framework | |
| 153 | +| Eible | LGPLv3 | https://github.com/przemek83/eible | library for importing and exporting data | |
| 154 | +| QwtBle | LGPLv3 | https://github.com/przemek83/qwtble | library of useful plots and one marker based on Qwt library | |
| 155 | +| Wble | LGPLv3 | https://github.com/przemek83/wble | library of useful Qt widgets | |
| 156 | +| QuaZip | LGPLv2.1 with static linking exception | https://github.com/stachenov/quazip | C++ wrapper for Minizip using Qt library | |
| 157 | + |
| 158 | + |
152 | 159 | ## Potential further improvements |
153 | 160 | * Upgrade code to use C++20. |
154 | 161 | * Measure and increase test coverage. |
|
0 commit comments