Skip to content

Commit 485f3dc

Browse files
committed
Update licensing secvtion, update table of contents.
1 parent 4bc1e92 commit 485f3dc

File tree

1 file changed

+20
-13
lines changed

1 file changed

+20
-13
lines changed

README.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,17 @@
88
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=przemek83_volbx&metric=coverage)](https://sonarcloud.io/summary/new_code?id=przemek83_volbx)
99
[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=przemek83_volbx&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=przemek83_volbx)
1010

11-
## Table of content
11+
## Table of contents
1212
- [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)
1818
- [Updater](#updater)
1919
- [Setup update server](#setup-update-server)
2020
- [Testing](#testing)
21+
- [Licensing](#licensing)
2122
- [Potential further improvements](#potential-further-improvements)
2223
- [Screenshots](#screenshots)
2324

@@ -66,13 +67,6 @@ As a result of compilation, binary for simulations and binary for testing should
6667
| Wble | 1.2.0 | 1.2.0 | 1.2.0 |
6768
| QuaZip | 1.4 | 1.4 | 1.4 |
6869

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-
7670
## Updater
7771
1) Build target `VersionCheck`.
7872
2) Run `VersionCheck`.
@@ -149,6 +143,19 @@ Total Test time (real) = 0.39 sec
149143
150144
```
151145

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+
152159
## Potential further improvements
153160
* Upgrade code to use C++20.
154161
* Measure and increase test coverage.

0 commit comments

Comments
 (0)